@epilot/sdk 2.15.4 → 2.15.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +280 -3
- package/definitions/pricing.json +14 -0
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.d.cts +2 -2
- package/dist/apis/pricing.d.ts +2 -2
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-7LWNOS5V.js → chunk-6DBGRVEF.js} +3 -3
- package/dist/{chunk-L4XLUNUO.js → chunk-EPDH37RS.js} +1 -1
- package/dist/{chunk-IZ52TBS7.cjs → chunk-LKV3RKOP.cjs} +1 -1
- package/dist/{chunk-E7FFVRBQ.cjs → chunk-VBTUFDXY.cjs} +3 -3
- package/dist/customer-portal-JDIXJD6C.cjs +7 -0
- package/dist/customer-portal-WIRQ7UCN.js +7 -0
- package/dist/{customer-portal-runtime-SOZ4QOVZ.cjs → customer-portal-runtime-7WW3YRWJ.cjs} +2 -2
- package/dist/{customer-portal-runtime-QM3MLBPV.js → customer-portal-runtime-FZQLCEJQ.js} +1 -1
- package/dist/{customer-portal.d-DsB3qJro.d.cts → customer-portal.d-JVkJjm_e.d.cts} +225 -5
- package/dist/{customer-portal.d-DsB3qJro.d.ts → customer-portal.d-JVkJjm_e.d.ts} +225 -5
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/pricing-CXWAKLA6.js +7 -0
- package/dist/pricing-L7VUML4H.cjs +7 -0
- package/dist/{pricing.d-gPt5L7wp.d.cts → pricing.d-BgjfwicJ.d.cts} +22 -1
- package/dist/{pricing.d-gPt5L7wp.d.ts → pricing.d-BgjfwicJ.d.ts} +22 -1
- package/docs/customer-portal.md +216 -0
- package/docs/pricing.md +11 -0
- package/package.json +1 -1
- package/dist/customer-portal-7ZNROWXS.js +0 -7
- package/dist/customer-portal-ZW4I52KG.cjs +0 -7
- package/dist/pricing-5Y7TZHMR.js +0 -7
- package/dist/pricing-BJUABPHU.cjs +0 -7
|
@@ -1 +1 @@
|
|
|
1
|
-
{"s":"https://customer-portal-api.sls.epilot.io","o":[["upsertPortal","post","/v2/portal/portal",[["origin","q",true],["portal_id","q"]],1],["createUser","post","/v2/portal/public/user",[["origin","q",true]],1],["createUserV3","post","/v3/portal/public/user",[["portal_id","q"],["domain","q"]],1],["validateToken","post","/v2/portal/token/validate"],["revokeToken","post","/v2/portal/token/revoke",null,1],["getPortalConfigByDomain","get","/v2/portal/public/config",[["domain","q",true]]],["getPortalConfig","get","/v2/portal/config",[["origin","q"]]],["deletePortal","delete","/v2/portal/config",[["origin","q",true]]],["createExport","post","/v1/portal/exports",null,1],["getExport","get","/v1/portal/exports/{jobId}",[["jobId","p",true]]],["getPortalExtensions","get","/v2/portal/extensions",[["origin","q"]]],["getPublicPortalExtensionDetails","get","/v2/portal/public/extensions",[["org_id","q",true],["origin","q",true]]],["getPortalExtensionsV3","get","/v3/portal/extensions",[["portal_id","q",true]]],["getPublicPortalExtensionDetailsV3","get","/v3/portal/public/extensions",[["org_id","q"],["portal_id","q"],["domain","q"]]],["getConsumption","get","/v2/portal/consumption",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["prepareVisualizationExport","post","/v2/portal/visualization:export",null,1],["getVisualizationMetadata","get","/v2/portal/visualization/metadata",[["app_id","q",true],["extensionId","q",true],["context_entities","q"]]],["getCosts","get","/v2/portal/costs",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getPrices","get","/v2/portal/prices",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getExternalLinks","get","/v2/portal/external-links",[["origin","q"],["contactId","q"]]],["getResolvedExternalLink","get","/v2/portal/resolve:external-link/{id}",[["id","p",true],["origin","q"],["contactId","q"]]],["getExternalLinksV3","get","/v3/portal/external-links",[["portal_id","q"],["contactId","q"]]],["getResolvedExternalLinkV3","get","/v3/portal/resolve:external-link/{id}",[["id","p",true],["portal_id","q"],["contactId","q"]]],["getResolvedSeamlessLink","get","/v2/portal/resolve:seamless-link",[["app_id","q"],["extension_id","q",true],["link_id","q",true],["context_entities","q"]]],["getPublicPortalConfig","get","/v2/portal/public/portal/config",[["org_id","q",true],["origin","q",true]]],["getOrgPortalConfig","get","/v2/portal/org/portal/config",[["origin","q",true]]],["getPublicPortalConfigV3","get","/v3/portal/public/portal/config",[["org_id","q",true],["portal_id","q",true]]],["getOrgPortalConfigV3","get","/v3/portal/org/portal/config",[["portal_id","q",true]]],["getAllPortalConfigs","get","/v2/portal/configs"],["upsertEmailTemplates","post","/v2/portal/email-templates",[["origin","q",true]],1],["getEmailTemplates","get","/v2/portal/email-templates",[["origin","q",true]]],["migrateEmailTemplateReferences","post","/v3/portal/email-templates:migrate-references",null,1],["listEmailTemplateReferences","post","/v3/portal/email-templates:list-references",null,1],["upsertEmailTemplatesByPortalId","post","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]],1],["getEmailTemplatesByPortalId","get","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]]],["getPublicPortalWidgets","get","/v2/portal/public-widgets",[["org_id","q",true],["origin","q",true]]],["getPublicPortalWidgetsV3","get","/v3/portal/public/widgets",[["org_id","q"],["portal_id","q"],["domain","q"]]],["upsertPortalWidget","post","/v2/portal/widgets",[["origin","q",true]],1],["getPortalWidgets","get","/v2/portal/widgets",[["origin","q"],["contract_id","q"]]],["getPortalWidgetsV3","get","/v3/portal/widgets",[["portal_id","q",true],["contract_id","q"]]],["upsertPortalWidgetV3","post","/v3/portal/widgets",[["portal_id","q",true]],1],["savePortalFilesV3","post","/v3/portal/portal/files",[["portal_id","q",true]],1],["replaceECPTemplateVariables","post","/v2/portal/replace-ecp-template-variables",null,1],["getOrganizationSettings","get","/v2/portal/org/settings"],["getSchemas","get","/v2/portal/schemas"],["getSchemasByDomain","get","/v2/portal/public/schemas",[["domain","q",true]]],["getPublicSchemasV3","get","/v3/portal/public/schemas",[["org_id","q"],["portal_id","q"],["domain","q"]]],["getOrganizationSettingsByDomain","get","/v2/portal/public/org/settings",[["domain","q",true]]],["extraPermissionAttributes","get","/v2/portal/extra-permission-attributes"],["validateCaaRecords","post","/v2/portal/validate/caa-records",[["origin","q",true]]],["validateCaaRecordsV3","post","/v3/portal/validate/caa-records",[["portal_id","q",true]]],["getContact","get","/v2/portal/contact"],["updateContact","patch","/v2/portal/contact",null,1],["getECPContact","get","/v2/portal/ecp/contact",[["id","q",true]]],["checkContactExists","post","/v2/portal/public/contact/exists",[["origin","q",true]],1],["checkContactExistsV3","post","/v3/portal/public/contact/exists",[["portal_id","q"],["domain","q"]],1],["checkAccountExists","post","/v3/portal/public/account/exists",[["portal_id","q"],["domain","q"]],1],["getValidSecondaryAttributes","get","/v2/portal/contact/valid/secondary/attributes"],["getPortalUser","get","/v2/portal/user"],["updatePortalUser","patch","/v2/portal/user",null,1],["deletePortalUser","delete","/v2/portal/user"],["updatePortalUserEmail","put","/v2/portal/user/update/email",null,1],["changePortalUserPassword","put","/v2/portal/user/change/password",null,1],["resendConfirmationEmail","post","/v2/portal/user/resend/confirmation-email/{id}",[["id","p",true]]],["fetchPortalUsersByRelatedEntity","get","/v2/portal/users/by-related-entity",[["entity_id","q",true],["slug","q",true]]],["confirmUser","get","/v2/portal/user/confirm",[["confirmation_link_token","q",true],["use_redirect","q"]]],["confirmUserWithUserId","get","/v2/portal/user/confirm/{id}",[["origin","q",true],["id","p",true],["org_id","q",true]]],["userExists","get","/v2/portal/public/user/exists",[["email","q",true],["org_id","q",true],["origin","q"]]],["userExistsV3","get","/v3/portal/public/user/exists",[["email","q",true],["org_id","q"],["portal_id","q"],["domain","q"]]],["getRecipientsToNotifyOnAutomation","post","/v2/portal/recipients-to-notify",null,1],["configureDistribution","get","/v2/portal/configure-distribution",[["origin","q",true]]],["configureDistributionV3","get","/v3/portal/configure-distribution",[["portal_id","q",true]]],["getAllOrders","get","/v2/portal/order",[["from","q"],["size","q"]]],["postOrderAcceptance","post","/v2/portal/order/{id}/acceptance",[["id","p",true]],1],["getOrder","get","/v2/portal/order/{id}",[["id","p",true]]],["updateOrder","patch","/v2/portal/order/{id}",[["id","p",true]],1],["getAllOpportunities","get","/v2/portal/opportunity",[["from","q"],["size","q"]]],["getSearchableAttributesForOpportunities","get","/v2/portal/opportunities/searchable-attributes",[["from","q"],["size","q"]]],["getSearchResultsForOpportunities","post","/v2/portal/opportunities/search",[["from","q"],["size","q"]],1],["getOpportunity","get","/v2/portal/opportunities/{id}",[["id","p",true]]],["updateOpportunity","patch","/v2/portal/opportunities/{id}",[["id","p",true]],1],["getAllRequests","get","/v2/portal/request",[["from","q"],["size","q"]]],["getAllContracts","get","/v2/portal/contract",[["from","q"],["size","q"]]],["getContract","get","/v2/portal/contract/{id}",[["id","p",true]]],["updateContract","patch","/v2/portal/contract/{id}",[["id","p",true]],1],["getContractWithTemplates","post","/v2/portal/contract/{id}/resolve-templates",[["id","p",true]],1],["addContractByIdentifiers","post","/v2/portal/contract/by-identifiers",null,1],["getEntityIdentifiers","get","/v2/portal/entity/identifiers/{slug}",[["slug","p",true]]],["getEntityActivityFeed","get","/v2/portal/entity/{slug}/{id}/activity",[["slug","p",true],["id","p",true],["after","q"],["before","q"],["from","q"],["size","q"],["type","q"],["include_relations","q"]]],["validateCadenceEntityEditRules","get","/v2/portal/{slug}/{id}:validateRule",[["slug","p",true],["id","p",true],["attribute","q"]]],["searchPaymentRelationsInEntities","get","/v2/portal/entities-by-payment/{id}",[["id","p",true]]],["createCustomEntityActivity","put","/v2/portal/entity/activity",[["entities","q",false,"form"]],1],["saveEntityFile","post","/v2/portal/entity/file",null,1],["deleteEntityFile","delete","/v2/portal/entity/file",null,1],["savePortalFiles","post","/v2/portal/portal/files",null,1],["getRegistrationIdentifiers","get","/v2/portal/registration/identifiers"],["getAllFiles","get","/v2/portal/user/files",[["from","q",true],["size","q",true],["entity_ids","q"],["file_types","q"]]],["getFileById","get","/v2/portal/user/file/{id}",[["id","p",true]]],["trackFileDownloaded","post","/v2/portal/user/file/{id}/downloaded",[["id","p",true]]],["getFilesCountByEntity","get","/v2/portal/user/files/count-by-entity"],["getBillingEvents","get","/v2/portal/billing/events",[["from","q"],["size","q"],["entity_id","q"],["event_type","q"],["paid","q"],["date_after","q"],["date_before","q"],["sort","q"]]],["getCustomerBalance","get","/v2/portal/billing/customers/balance"],["getBillingAccount","get","/v2/portal/billing/accounts/{id}"],["loginToPortalAsUser","post","/v2/portal/admin:login-as-user",null,1],["triggerEntityAccessEvent","post","/v2/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["origin","q",true]]],["triggerEntityAccessEventV3","post","/v3/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["portal_id","q"],["domain","q"]]],["getPortalUserEntity","post","/v2/portal/entity:get",null,1],["searchPortalUserEntities","post","/v2/portal/entity:search",null,1],["createPortalUserEntity","post","/v2/portal/entity/{slug}",[["slug","p",true]],1],["patchPortalUserEntity","patch","/v2/portal/entity/{slug}/{id}",[["slug","p",true],["id","p",true]],1],["canTriggerPortalFlow","post","/v2/portal/can-trigger-portal-flow",[["origin","q"],["portal_id","q",true]],1],["getAutomationContext","get","/v2/portal/automation-context",[["activity_id","q",true],["type","q",true]]],["updateWorkflowStepAsDone","put","/v2/portal/workflow/{workflow_id}/{step_id}:markDone",[["workflow_id","p",true],["step_id","p",true]]],["getEntityWorkflows","get","/v2/portal/entity/{slug}/{id}/workflows",[["slug","p",true],["id","p",true]]],["uploadMeterReadingPhoto","post","/v2/portal/metering/reading/photo",null,1],["createMeterReading","post","/v2/portal/metering/reading",[["override_plausibility","q"]],1],["getAllowedMeterReadingRange","get","/v2/portal/metering/reading/allowed-range/{meter_id}",[["meter_id","p",true],["origin","q"],["timestamp","q"],["context_entities","q"]]],["getMeterReadings","post","/v2/portal/metering/readings",null,1],["getSSOProvider","get","/v2/portal/public/sso/providers/{provider_slug}",[["provider_slug","p",true],["org_id","q"],["origin","q"],["portal_id","q"],["domain","q"]]],["ssoLogin","post","/v2/portal/public/sso/login",[["origin","q",true],["org_id","q",true],["contact_id","q"]],1],["ssoLoginV3","post","/v3/portal/public/sso/login",[["portal_id","q"],["org_id","q"],["domain","q"],["contact_id","q"]],1],["ssoRedirect","post","/v2/portal/public/sso/redirect",[["web_uri","q",true]],1],["ssoCallback","post","/v2/portal/public/sso/callback",[["domain","q"]],1],["getPortalPage","get","/v2/portal/pages/{id}"],["updatePortalPage","put","/v2/portal/pages/{id}",null,1],["deletePortalPage","delete","/v2/portal/pages/{id}"],["getPortalPages","get","/v2/portal/pages",[["fields","q"],["filter","q"],["contract_id","q"],["context_entities","q"]]],["createPortalPage","post","/v2/portal/pages",null,1],["getPublicPages","get","/v2/portal/public/pages",[["domain","q",true],["fields","q"],["filter","q"]]],["interpolatePortalPages","post","/v2/portal/pages/interpolate",null,1],["getTriggeredJourney","get","/v2/portal/config/triggered-journeys/{trigger_name}",[["context_entities","q"]]],["getDefaultPages","get","/v2/portal/pages/default"],["createPortalPageBlock","post","/v2/portal/pages/{id}/blocks",null,1],["getPortalPageBlocks","get","/v2/portal/pages/{id}/blocks"],["getPortalPageBlock","get","/v2/portal/pages/{id}/blocks/{block_id}"],["updatePortalPageBlock","put","/v2/portal/pages/{id}/blocks/{block_id}",null,1],["deletePortalPageBlock","delete","/v2/portal/pages/{id}/blocks/{block_id}"],["getUserEntryPoint","get","/v2/portal/public/user/entry-point",[["email","q",true],["domain","q",true]]],["updateCampaignPortalBlockStatus","put","/v2/portal/campaign/{campaign_id}/entity:status",[["campaign_id","p",true]],1],["updateNotificationsStatus","put","/v2/portal/notifications/entity:status",null,1],["deRegisterMLoginUser","delete","/v2/portal/public/m-login/deregister/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]]],["notifyMLoginInterestChange","post","/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]],1],["createPortalConfig","post","/v3/portal/config",null,1],["getPortalConfigV3","get","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["putPortalConfig","put","/v3/portal/config/{portal_id}",[["portal_id","p",true],["page_upsert_mode","q"]],1],["deletePortalConfig","delete","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["listAllPortalConfigs","get","/v3/portal/configs"],["swapPortalConfig","post","/v3/portal/config/swap",null,1],["clonePortalConfig","post","/v3/portal/config/clone",null,1],["invitePartner","post","/v3/portal/partner/invite",null,1],["listBusinessPartners","get","/v3/portal/partner/list"],["resendPartnerInvitation","post","/v3/portal/partner/{partner_id}/resend-invitation",[["partner_id","p",true]]],["revokePartner","delete","/v3/portal/partner/{partner_id}/revoke",[["partner_id","p",true]]],["disablePartner","post","/v3/portal/partner/{partner_id}/disable",[["partner_id","p",true]]],["enablePartner","post","/v3/portal/partner/{partner_id}/enable",[["partner_id","p",true]]],["verifyDns","post","/v3/portal/verify-dns",[["portal_id","q",true]]],["portalProxyExecute","post","/v2/portal/proxy/execute",null,1],["getMobileConfig","get","/v1/portal/mobile-config",[["portal_id","q",true],["raw","q"]]],["putMobileConfig","put","/v1/portal/mobile-config",[["portal_id","q",true]],1]],"v":"3.0.3","pp":{"/v2/portal/billing/accounts/{id}":[["id","p",true]],"/v2/portal/pages/{id}":[["id","p",true]],"/v2/portal/pages":[["domain","q",true]],"/v2/portal/config/triggered-journeys/{trigger_name}":[["trigger_name","p",true]],"/v2/portal/pages/{id}/blocks":[["id","p",true]],"/v2/portal/pages/{id}/blocks/{block_id}":[["id","p",true],["block_id","p",true]]}}
|
|
1
|
+
{"s":"https://customer-portal-api.sls.epilot.io","o":[["upsertPortal","post","/v2/portal/portal",[["origin","q",true],["portal_id","q"]],1],["createUser","post","/v2/portal/public/user",[["origin","q",true]],1],["createUserV3","post","/v3/portal/public/user",[["portal_id","q"],["domain","q"]],1],["validateToken","post","/v2/portal/token/validate"],["revokeToken","post","/v2/portal/token/revoke",null,1],["getPortalConfigByDomain","get","/v2/portal/public/config",[["domain","q",true]]],["getPortalConfig","get","/v2/portal/config",[["origin","q"]]],["deletePortal","delete","/v2/portal/config",[["origin","q",true]]],["createExport","post","/v1/portal/exports",null,1],["getExport","get","/v1/portal/exports/{jobId}",[["jobId","p",true]]],["getPortalExtensions","get","/v2/portal/extensions",[["origin","q"]]],["getPublicPortalExtensionDetails","get","/v2/portal/public/extensions",[["org_id","q",true],["origin","q",true]]],["getPortalExtensionsV3","get","/v3/portal/extensions",[["portal_id","q",true]]],["getPublicPortalExtensionDetailsV3","get","/v3/portal/public/extensions",[["org_id","q"],["portal_id","q"],["domain","q"]]],["getConsumption","get","/v2/portal/consumption",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["prepareVisualizationExport","post","/v2/portal/visualization:export",null,1],["getVisualizationMetadata","get","/v2/portal/visualization/metadata",[["app_id","q",true],["extensionId","q",true],["context_entities","q"]]],["getCosts","get","/v2/portal/costs",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getPrices","get","/v2/portal/prices",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getExternalLinks","get","/v2/portal/external-links",[["origin","q"],["contactId","q"]]],["getResolvedExternalLink","get","/v2/portal/resolve:external-link/{id}",[["id","p",true],["origin","q"],["contactId","q"]]],["getExternalLinksV3","get","/v3/portal/external-links",[["portal_id","q"],["contactId","q"]]],["getResolvedExternalLinkV3","get","/v3/portal/resolve:external-link/{id}",[["id","p",true],["portal_id","q"],["contactId","q"]]],["getResolvedSeamlessLink","get","/v2/portal/resolve:seamless-link",[["app_id","q"],["extension_id","q",true],["link_id","q",true],["context_entities","q"]]],["getPublicPortalConfig","get","/v2/portal/public/portal/config",[["org_id","q",true],["origin","q",true]]],["getOrgPortalConfig","get","/v2/portal/org/portal/config",[["origin","q",true]]],["getPublicPortalConfigV3","get","/v3/portal/public/portal/config",[["org_id","q",true],["portal_id","q",true]]],["getOrgPortalConfigV3","get","/v3/portal/org/portal/config",[["portal_id","q",true]]],["getAllPortalConfigs","get","/v2/portal/configs"],["upsertEmailTemplates","post","/v2/portal/email-templates",[["origin","q",true]],1],["getEmailTemplates","get","/v2/portal/email-templates",[["origin","q",true]]],["migrateEmailTemplateReferences","post","/v3/portal/email-templates:migrate-references",null,1],["listEmailTemplateReferences","post","/v3/portal/email-templates:list-references",null,1],["upsertEmailTemplatesByPortalId","post","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]],1],["getEmailTemplatesByPortalId","get","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]]],["getPublicPortalWidgets","get","/v2/portal/public-widgets",[["org_id","q",true],["origin","q",true]]],["getPublicPortalWidgetsV3","get","/v3/portal/public/widgets",[["org_id","q"],["portal_id","q"],["domain","q"]]],["upsertPortalWidget","post","/v2/portal/widgets",[["origin","q",true]],1],["getPortalWidgets","get","/v2/portal/widgets",[["origin","q"],["contract_id","q"]]],["getPortalWidgetsV3","get","/v3/portal/widgets",[["portal_id","q",true],["contract_id","q"]]],["upsertPortalWidgetV3","post","/v3/portal/widgets",[["portal_id","q",true]],1],["savePortalFilesV3","post","/v3/portal/portal/files",[["portal_id","q",true]],1],["replaceECPTemplateVariables","post","/v2/portal/replace-ecp-template-variables",null,1],["getOrganizationSettings","get","/v2/portal/org/settings"],["getSchemas","get","/v2/portal/schemas"],["getSchemasByDomain","get","/v2/portal/public/schemas",[["domain","q",true]]],["getPublicSchemasV3","get","/v3/portal/public/schemas",[["org_id","q"],["portal_id","q"],["domain","q"]]],["getOrganizationSettingsByDomain","get","/v2/portal/public/org/settings",[["domain","q",true]]],["extraPermissionAttributes","get","/v2/portal/extra-permission-attributes"],["validateCaaRecords","post","/v2/portal/validate/caa-records",[["origin","q",true]]],["validateCaaRecordsV3","post","/v3/portal/validate/caa-records",[["portal_id","q",true]]],["getContact","get","/v2/portal/contact"],["updateContact","patch","/v2/portal/contact",null,1],["getECPContact","get","/v2/portal/ecp/contact",[["id","q",true]]],["checkContactExists","post","/v2/portal/public/contact/exists",[["origin","q",true]],1],["checkContactExistsV3","post","/v3/portal/public/contact/exists",[["portal_id","q"],["domain","q"]],1],["checkAccountExists","post","/v3/portal/public/account/exists",[["portal_id","q"],["domain","q"]],1],["getValidSecondaryAttributes","get","/v2/portal/contact/valid/secondary/attributes"],["getPortalUser","get","/v2/portal/user"],["updatePortalUser","patch","/v2/portal/user",null,1],["deletePortalUser","delete","/v2/portal/user"],["updatePortalUserEmail","put","/v2/portal/user/update/email",null,1],["changePortalUserPassword","put","/v2/portal/user/change/password",null,1],["resendConfirmationEmail","post","/v2/portal/user/resend/confirmation-email/{id}",[["id","p",true]]],["fetchPortalUsersByRelatedEntity","get","/v2/portal/users/by-related-entity",[["entity_id","q",true],["slug","q",true]]],["confirmUser","get","/v2/portal/user/confirm",[["confirmation_link_token","q",true],["use_redirect","q"]]],["confirmUserWithUserId","get","/v2/portal/user/confirm/{id}",[["origin","q",true],["id","p",true],["org_id","q",true]]],["userExists","get","/v2/portal/public/user/exists",[["email","q",true],["org_id","q",true],["origin","q"]]],["userExistsV3","get","/v3/portal/public/user/exists",[["email","q",true],["org_id","q"],["portal_id","q"],["domain","q"]]],["getRecipientsToNotifyOnAutomation","post","/v2/portal/recipients-to-notify",null,1],["configureDistribution","get","/v2/portal/configure-distribution",[["origin","q",true]]],["configureDistributionV3","get","/v3/portal/configure-distribution",[["portal_id","q",true]]],["getAllOrders","get","/v2/portal/order",[["from","q"],["size","q"]]],["postOrderAcceptance","post","/v2/portal/order/{id}/acceptance",[["id","p",true]],1],["getOrder","get","/v2/portal/order/{id}",[["id","p",true]]],["updateOrder","patch","/v2/portal/order/{id}",[["id","p",true]],1],["getAllOpportunities","get","/v2/portal/opportunity",[["from","q"],["size","q"]]],["getSearchableAttributesForOpportunities","get","/v2/portal/opportunities/searchable-attributes",[["from","q"],["size","q"]]],["getSearchResultsForOpportunities","post","/v2/portal/opportunities/search",[["from","q"],["size","q"]],1],["getOpportunity","get","/v2/portal/opportunities/{id}",[["id","p",true]]],["updateOpportunity","patch","/v2/portal/opportunities/{id}",[["id","p",true]],1],["getAllRequests","get","/v2/portal/request",[["from","q"],["size","q"]]],["getAllContracts","get","/v2/portal/contract",[["from","q"],["size","q"]]],["getContract","get","/v2/portal/contract/{id}",[["id","p",true]]],["updateContract","patch","/v2/portal/contract/{id}",[["id","p",true]],1],["getContractWithTemplates","post","/v2/portal/contract/{id}/resolve-templates",[["id","p",true]],1],["addContractByIdentifiers","post","/v2/portal/contract/by-identifiers",null,1],["getEntityIdentifiers","get","/v2/portal/entity/identifiers/{slug}",[["slug","p",true]]],["getEntityActivityFeed","get","/v2/portal/entity/{slug}/{id}/activity",[["slug","p",true],["id","p",true],["after","q"],["before","q"],["from","q"],["size","q"],["type","q"],["include_relations","q"]]],["validateCadenceEntityEditRules","get","/v2/portal/{slug}/{id}:validateRule",[["slug","p",true],["id","p",true],["attribute","q"]]],["searchPaymentRelationsInEntities","get","/v2/portal/entities-by-payment/{id}",[["id","p",true]]],["createCustomEntityActivity","put","/v2/portal/entity/activity",[["entities","q",false,"form"]],1],["saveEntityFile","post","/v2/portal/entity/file",null,1],["deleteEntityFile","delete","/v2/portal/entity/file",null,1],["savePortalFiles","post","/v2/portal/portal/files",null,1],["getRegistrationIdentifiers","get","/v2/portal/registration/identifiers"],["getAllFiles","get","/v2/portal/user/files",[["from","q",true],["size","q",true],["entity_ids","q"],["file_types","q"]]],["getFileById","get","/v2/portal/user/file/{id}",[["id","p",true]]],["trackFileDownloaded","post","/v2/portal/user/file/{id}/downloaded",[["id","p",true]]],["getFilesCountByEntity","get","/v2/portal/user/files/count-by-entity"],["getBillingEvents","get","/v2/portal/billing/events",[["from","q"],["size","q"],["entity_id","q"],["event_type","q"],["paid","q"],["date_after","q"],["date_before","q"],["sort","q"]]],["getCustomerBalance","get","/v2/portal/billing/customers/balance"],["getBillingAccount","get","/v2/portal/billing/accounts/{id}"],["loginToPortalAsUser","post","/v2/portal/admin:login-as-user",null,1],["triggerEntityAccessEvent","post","/v2/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["origin","q",true]]],["triggerEntityAccessEventV3","post","/v3/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["portal_id","q"],["domain","q"]]],["getPortalUserEntity","post","/v2/portal/entity:get",null,1],["searchPortalUserEntities","post","/v2/portal/entity:search",null,1],["createPortalUserEntity","post","/v2/portal/entity/{slug}",[["slug","p",true]],1],["patchPortalUserEntity","patch","/v2/portal/entity/{slug}/{id}",[["slug","p",true],["id","p",true]],1],["canTriggerPortalFlow","post","/v2/portal/can-trigger-portal-flow",[["origin","q"],["portal_id","q",true]],1],["getAutomationContext","get","/v2/portal/automation-context",[["activity_id","q",true],["type","q",true]]],["updateWorkflowStepAsDone","put","/v2/portal/workflow/{workflow_id}/{step_id}:markDone",[["workflow_id","p",true],["step_id","p",true]]],["getEntityWorkflows","get","/v2/portal/entity/{slug}/{id}/workflows",[["slug","p",true],["id","p",true]]],["getEntityPortalWorkflows","get","/v2/portal/entity/{slug}/{id}/workflows/linearized",[["slug","p",true],["id","p",true]]],["uploadMeterReadingPhoto","post","/v2/portal/metering/reading/photo",null,1],["createMeterReading","post","/v2/portal/metering/reading",[["override_plausibility","q"]],1],["getAllowedMeterReadingRange","get","/v2/portal/metering/reading/allowed-range/{meter_id}",[["meter_id","p",true],["origin","q"],["timestamp","q"],["context_entities","q"]]],["getMeterReadings","post","/v2/portal/metering/readings",null,1],["getSSOProvider","get","/v2/portal/public/sso/providers/{provider_slug}",[["provider_slug","p",true],["org_id","q"],["origin","q"],["portal_id","q"],["domain","q"]]],["ssoLogin","post","/v2/portal/public/sso/login",[["origin","q",true],["org_id","q",true],["contact_id","q"]],1],["ssoLoginV3","post","/v3/portal/public/sso/login",[["portal_id","q"],["org_id","q"],["domain","q"],["contact_id","q"]],1],["ssoRedirect","post","/v2/portal/public/sso/redirect",[["web_uri","q",true]],1],["ssoCallback","post","/v2/portal/public/sso/callback",[["domain","q"]],1],["getPortalPage","get","/v2/portal/pages/{id}"],["updatePortalPage","put","/v2/portal/pages/{id}",null,1],["deletePortalPage","delete","/v2/portal/pages/{id}"],["getPortalPages","get","/v2/portal/pages",[["fields","q"],["filter","q"],["contract_id","q"],["context_entities","q"]]],["createPortalPage","post","/v2/portal/pages",null,1],["getPublicPages","get","/v2/portal/public/pages",[["domain","q",true],["fields","q"],["filter","q"]]],["interpolatePortalPages","post","/v2/portal/pages/interpolate",null,1],["getTriggeredJourney","get","/v2/portal/config/triggered-journeys/{trigger_name}",[["context_entities","q"]]],["getDefaultPages","get","/v2/portal/pages/default"],["createPortalPageBlock","post","/v2/portal/pages/{id}/blocks",null,1],["getPortalPageBlocks","get","/v2/portal/pages/{id}/blocks"],["getPortalPageBlock","get","/v2/portal/pages/{id}/blocks/{block_id}"],["updatePortalPageBlock","put","/v2/portal/pages/{id}/blocks/{block_id}",null,1],["deletePortalPageBlock","delete","/v2/portal/pages/{id}/blocks/{block_id}"],["getUserEntryPoint","get","/v2/portal/public/user/entry-point",[["email","q",true],["domain","q",true]]],["updateCampaignPortalBlockStatus","put","/v2/portal/campaign/{campaign_id}/entity:status",[["campaign_id","p",true]],1],["updateNotificationsStatus","put","/v2/portal/notifications/entity:status",null,1],["deRegisterMLoginUser","delete","/v2/portal/public/m-login/deregister/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]]],["notifyMLoginInterestChange","post","/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]],1],["createPortalConfig","post","/v3/portal/config",null,1],["getPortalConfigV3","get","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["putPortalConfig","put","/v3/portal/config/{portal_id}",[["portal_id","p",true],["page_upsert_mode","q"]],1],["deletePortalConfig","delete","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["listAllPortalConfigs","get","/v3/portal/configs"],["swapPortalConfig","post","/v3/portal/config/swap",null,1],["clonePortalConfig","post","/v3/portal/config/clone",null,1],["invitePartner","post","/v3/portal/partner/invite",null,1],["listBusinessPartners","get","/v3/portal/partner/list"],["resendPartnerInvitation","post","/v3/portal/partner/{partner_id}/resend-invitation",[["partner_id","p",true]]],["revokePartner","delete","/v3/portal/partner/{partner_id}/revoke",[["partner_id","p",true]]],["disablePartner","post","/v3/portal/partner/{partner_id}/disable",[["partner_id","p",true]]],["enablePartner","post","/v3/portal/partner/{partner_id}/enable",[["partner_id","p",true]]],["verifyDns","post","/v3/portal/verify-dns",[["portal_id","q",true]]],["portalProxyExecute","post","/v2/portal/proxy/execute",null,1],["getMobileConfig","get","/v1/portal/mobile-config",[["portal_id","q",true],["raw","q"]]],["putMobileConfig","put","/v1/portal/mobile-config",[["portal_id","q",true]],1]],"v":"3.0.3","pp":{"/v2/portal/billing/accounts/{id}":[["id","p",true]],"/v2/portal/pages/{id}":[["id","p",true]],"/v2/portal/pages":[["domain","q",true]],"/v2/portal/config/triggered-journeys/{trigger_name}":[["trigger_name","p",true]],"/v2/portal/pages/{id}/blocks":[["id","p",true]],"/v2/portal/pages/{id}/blocks/{block_id}":[["id","p",true],["block_id","p",true]]}}
|
|
@@ -4252,7 +4252,7 @@
|
|
|
4252
4252
|
},
|
|
4253
4253
|
"password": {
|
|
4254
4254
|
"type": "string",
|
|
4255
|
-
"description": "Password of the portal user for confirmation.\nRequired unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal
|
|
4255
|
+
"description": "Password of the portal user for confirmation.\nRequired unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal,\nor the portal user's identity is managed by an identity provider - an SSO login has no password to confirm.\n"
|
|
4256
4256
|
}
|
|
4257
4257
|
}
|
|
4258
4258
|
}
|
|
@@ -7977,6 +7977,75 @@
|
|
|
7977
7977
|
}
|
|
7978
7978
|
}
|
|
7979
7979
|
},
|
|
7980
|
+
"/v2/portal/entity/{slug}/{id}/workflows/linearized": {
|
|
7981
|
+
"get": {
|
|
7982
|
+
"operationId": "getEntityPortalWorkflows",
|
|
7983
|
+
"summary": "Get linearized workflows for an entity",
|
|
7984
|
+
"description": "Get all portal-relevant workflows associated with an entity (requires access to the entity),\nlinearized by the Workflows API into a flat, ordered list of portal-visible tasks.\n\nUnlike `getEntityWorkflows`, this endpoint returns a single uniform shape for both legacy\n(V1) workflow executions and graph-based (V2) flow executions — the execution graph is\nalready resolved server-side (active path, task reachability, chronological ordering), so\nclients can render a timeline without any graph traversal logic.\n\nTasks carry the config of both portal audiences (`ecp` and `installer`); clients filter\nper their configured audience, so one response serves every block on a page.\n",
|
|
7985
|
+
"tags": [
|
|
7986
|
+
"ECP"
|
|
7987
|
+
],
|
|
7988
|
+
"security": [
|
|
7989
|
+
{
|
|
7990
|
+
"PortalAuth": []
|
|
7991
|
+
}
|
|
7992
|
+
],
|
|
7993
|
+
"parameters": [
|
|
7994
|
+
{
|
|
7995
|
+
"in": "path",
|
|
7996
|
+
"name": "slug",
|
|
7997
|
+
"required": true,
|
|
7998
|
+
"schema": {
|
|
7999
|
+
"type": "string",
|
|
8000
|
+
"description": "Schema slug of the entity",
|
|
8001
|
+
"example": "opportunity"
|
|
8002
|
+
}
|
|
8003
|
+
},
|
|
8004
|
+
{
|
|
8005
|
+
"in": "path",
|
|
8006
|
+
"name": "id",
|
|
8007
|
+
"required": true,
|
|
8008
|
+
"schema": {
|
|
8009
|
+
"type": "string",
|
|
8010
|
+
"description": "ID of the entity",
|
|
8011
|
+
"example": "abc123"
|
|
8012
|
+
}
|
|
8013
|
+
}
|
|
8014
|
+
],
|
|
8015
|
+
"responses": {
|
|
8016
|
+
"200": {
|
|
8017
|
+
"description": "Portal-relevant workflows for the entity, each with linearized tasks",
|
|
8018
|
+
"content": {
|
|
8019
|
+
"application/json": {
|
|
8020
|
+
"schema": {
|
|
8021
|
+
"type": "object",
|
|
8022
|
+
"properties": {
|
|
8023
|
+
"portal_workflows": {
|
|
8024
|
+
"type": "array",
|
|
8025
|
+
"items": {
|
|
8026
|
+
"$ref": "#/components/schemas/PortalWorkflow"
|
|
8027
|
+
}
|
|
8028
|
+
}
|
|
8029
|
+
}
|
|
8030
|
+
}
|
|
8031
|
+
}
|
|
8032
|
+
}
|
|
8033
|
+
},
|
|
8034
|
+
"401": {
|
|
8035
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
8036
|
+
},
|
|
8037
|
+
"403": {
|
|
8038
|
+
"$ref": "#/components/responses/Forbidden"
|
|
8039
|
+
},
|
|
8040
|
+
"404": {
|
|
8041
|
+
"$ref": "#/components/responses/NotFound"
|
|
8042
|
+
},
|
|
8043
|
+
"500": {
|
|
8044
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
8045
|
+
}
|
|
8046
|
+
}
|
|
8047
|
+
}
|
|
8048
|
+
},
|
|
7980
8049
|
"/v2/portal/metering/reading/photo": {
|
|
7981
8050
|
"post": {
|
|
7982
8051
|
"operationId": "uploadMeterReadingPhoto",
|
|
@@ -14623,6 +14692,214 @@
|
|
|
14623
14692
|
"completedTime": "2024-01-13T05:18:43.827Z"
|
|
14624
14693
|
}
|
|
14625
14694
|
},
|
|
14695
|
+
"PortalWorkflow": {
|
|
14696
|
+
"type": "object",
|
|
14697
|
+
"description": "A portal-facing projection of a workflow execution (V1 or V2), with the execution\ngraph already linearized by the Workflows API into a flat, ordered list of\nportal-visible tasks.\n",
|
|
14698
|
+
"properties": {
|
|
14699
|
+
"id": {
|
|
14700
|
+
"type": "string",
|
|
14701
|
+
"description": "Id of the workflow / flow execution"
|
|
14702
|
+
},
|
|
14703
|
+
"definition_id": {
|
|
14704
|
+
"type": "string",
|
|
14705
|
+
"description": "Id of the workflow definition / flow template this execution was created from"
|
|
14706
|
+
},
|
|
14707
|
+
"name": {
|
|
14708
|
+
"type": "string"
|
|
14709
|
+
},
|
|
14710
|
+
"status": {
|
|
14711
|
+
"type": "string",
|
|
14712
|
+
"enum": [
|
|
14713
|
+
"STARTED",
|
|
14714
|
+
"DONE",
|
|
14715
|
+
"CLOSED"
|
|
14716
|
+
]
|
|
14717
|
+
},
|
|
14718
|
+
"version": {
|
|
14719
|
+
"type": "integer",
|
|
14720
|
+
"description": "2 = legacy V1 workflow execution (linear model), 3 = V2 flow execution (graph model)",
|
|
14721
|
+
"enum": [
|
|
14722
|
+
2,
|
|
14723
|
+
3
|
|
14724
|
+
]
|
|
14725
|
+
},
|
|
14726
|
+
"created_at": {
|
|
14727
|
+
"type": "string",
|
|
14728
|
+
"description": "Creation timestamp, doubles as started time"
|
|
14729
|
+
},
|
|
14730
|
+
"updated_at": {
|
|
14731
|
+
"type": "string",
|
|
14732
|
+
"description": "Last update timestamp"
|
|
14733
|
+
},
|
|
14734
|
+
"completed_at": {
|
|
14735
|
+
"type": "string",
|
|
14736
|
+
"description": "Timestamp when the execution was completed, if it is"
|
|
14737
|
+
},
|
|
14738
|
+
"due_date": {
|
|
14739
|
+
"type": "string"
|
|
14740
|
+
},
|
|
14741
|
+
"assigned_to": {
|
|
14742
|
+
"type": "array",
|
|
14743
|
+
"items": {
|
|
14744
|
+
"type": "string"
|
|
14745
|
+
}
|
|
14746
|
+
},
|
|
14747
|
+
"contexts": {
|
|
14748
|
+
"type": "array",
|
|
14749
|
+
"items": {
|
|
14750
|
+
"type": "object",
|
|
14751
|
+
"properties": {
|
|
14752
|
+
"entity_id": {
|
|
14753
|
+
"type": "string"
|
|
14754
|
+
},
|
|
14755
|
+
"entity_schema": {
|
|
14756
|
+
"type": "string"
|
|
14757
|
+
},
|
|
14758
|
+
"is_primary": {
|
|
14759
|
+
"type": "boolean"
|
|
14760
|
+
}
|
|
14761
|
+
}
|
|
14762
|
+
}
|
|
14763
|
+
},
|
|
14764
|
+
"is_path_complete": {
|
|
14765
|
+
"type": "boolean",
|
|
14766
|
+
"description": "True when the linearized path reached the end of the execution graph. False when an\nunevaluated decision task was encountered, meaning additional tasks may appear once\nthe decision is resolved (the returned tasks are still the guaranteed active path).\nAlways true for V1 executions.\n"
|
|
14767
|
+
},
|
|
14768
|
+
"tasks": {
|
|
14769
|
+
"type": "array",
|
|
14770
|
+
"description": "Portal-visible tasks in linear (timeline) order",
|
|
14771
|
+
"items": {
|
|
14772
|
+
"$ref": "#/components/schemas/PortalWorkflowTask"
|
|
14773
|
+
}
|
|
14774
|
+
}
|
|
14775
|
+
},
|
|
14776
|
+
"required": [
|
|
14777
|
+
"id",
|
|
14778
|
+
"name",
|
|
14779
|
+
"status",
|
|
14780
|
+
"version",
|
|
14781
|
+
"is_path_complete",
|
|
14782
|
+
"tasks"
|
|
14783
|
+
]
|
|
14784
|
+
},
|
|
14785
|
+
"PortalWorkflowTask": {
|
|
14786
|
+
"type": "object",
|
|
14787
|
+
"description": "A single portal-visible task of a linearized workflow execution",
|
|
14788
|
+
"properties": {
|
|
14789
|
+
"id": {
|
|
14790
|
+
"type": "string",
|
|
14791
|
+
"description": "Id of the underlying task (V2) or step (V1)"
|
|
14792
|
+
},
|
|
14793
|
+
"name": {
|
|
14794
|
+
"type": "string",
|
|
14795
|
+
"description": "Internal task/step name (fallback label when the portal config has none)"
|
|
14796
|
+
},
|
|
14797
|
+
"order": {
|
|
14798
|
+
"type": "integer",
|
|
14799
|
+
"description": "Zero-based position of the task in the linearized timeline"
|
|
14800
|
+
},
|
|
14801
|
+
"status": {
|
|
14802
|
+
"type": "string",
|
|
14803
|
+
"enum": [
|
|
14804
|
+
"COMPLETED",
|
|
14805
|
+
"SKIPPED",
|
|
14806
|
+
"IN_PROGRESS",
|
|
14807
|
+
"PENDING"
|
|
14808
|
+
],
|
|
14809
|
+
"description": "Normalized task status:\n- COMPLETED / SKIPPED: the task is done (skipped tasks count as done for progress)\n- IN_PROGRESS: the task has been reached and work has started\n- PENDING: the task has not been completed yet\n"
|
|
14810
|
+
},
|
|
14811
|
+
"is_active": {
|
|
14812
|
+
"type": "boolean",
|
|
14813
|
+
"description": "True when the task has been reached in the execution — all predecessor tasks on its\npath are completed/skipped — so the portal user can act on it (e.g. start its journey).\nTasks that are only part of the projected future path are returned with is_active false.\n"
|
|
14814
|
+
},
|
|
14815
|
+
"ecp": {
|
|
14816
|
+
"$ref": "#/components/schemas/PortalTaskConfig"
|
|
14817
|
+
},
|
|
14818
|
+
"installer": {
|
|
14819
|
+
"$ref": "#/components/schemas/PortalTaskConfig"
|
|
14820
|
+
},
|
|
14821
|
+
"journey": {
|
|
14822
|
+
"type": "object",
|
|
14823
|
+
"description": "Journey linked to the task, if any",
|
|
14824
|
+
"properties": {
|
|
14825
|
+
"id": {
|
|
14826
|
+
"type": "string"
|
|
14827
|
+
},
|
|
14828
|
+
"journeyId": {
|
|
14829
|
+
"type": "string"
|
|
14830
|
+
},
|
|
14831
|
+
"name": {
|
|
14832
|
+
"type": "string"
|
|
14833
|
+
},
|
|
14834
|
+
"complete_task_automatically": {
|
|
14835
|
+
"type": "boolean",
|
|
14836
|
+
"description": "If true, the task is auto completed when the journey is completed"
|
|
14837
|
+
}
|
|
14838
|
+
}
|
|
14839
|
+
},
|
|
14840
|
+
"assigned_to": {
|
|
14841
|
+
"type": "array",
|
|
14842
|
+
"items": {
|
|
14843
|
+
"type": "string"
|
|
14844
|
+
}
|
|
14845
|
+
},
|
|
14846
|
+
"phase_id": {
|
|
14847
|
+
"type": "string",
|
|
14848
|
+
"description": "Id of the phase the underlying task belongs to, if any (V2 only)"
|
|
14849
|
+
},
|
|
14850
|
+
"phase_name": {
|
|
14851
|
+
"type": "string",
|
|
14852
|
+
"description": "Name of the phase the underlying task belongs to, if any (V2 only)"
|
|
14853
|
+
},
|
|
14854
|
+
"completed_at": {
|
|
14855
|
+
"type": "string",
|
|
14856
|
+
"description": "Timestamp when the task was completed or skipped"
|
|
14857
|
+
},
|
|
14858
|
+
"updated_at": {
|
|
14859
|
+
"type": "string",
|
|
14860
|
+
"description": "Last update timestamp of the underlying task/step"
|
|
14861
|
+
}
|
|
14862
|
+
},
|
|
14863
|
+
"required": [
|
|
14864
|
+
"id",
|
|
14865
|
+
"name",
|
|
14866
|
+
"order",
|
|
14867
|
+
"status",
|
|
14868
|
+
"is_active"
|
|
14869
|
+
]
|
|
14870
|
+
},
|
|
14871
|
+
"PortalTaskConfig": {
|
|
14872
|
+
"type": "object",
|
|
14873
|
+
"description": "Portal-specific (ECP / installer) display config of a workflow task",
|
|
14874
|
+
"properties": {
|
|
14875
|
+
"enabled": {
|
|
14876
|
+
"type": "boolean"
|
|
14877
|
+
},
|
|
14878
|
+
"label": {
|
|
14879
|
+
"type": "string"
|
|
14880
|
+
},
|
|
14881
|
+
"description": {
|
|
14882
|
+
"type": "string"
|
|
14883
|
+
},
|
|
14884
|
+
"journey": {
|
|
14885
|
+
"type": "object",
|
|
14886
|
+
"properties": {
|
|
14887
|
+
"id": {
|
|
14888
|
+
"type": "string"
|
|
14889
|
+
},
|
|
14890
|
+
"journeyId": {
|
|
14891
|
+
"type": "string"
|
|
14892
|
+
},
|
|
14893
|
+
"name": {
|
|
14894
|
+
"type": "string"
|
|
14895
|
+
},
|
|
14896
|
+
"complete_task_automatically": {
|
|
14897
|
+
"type": "boolean"
|
|
14898
|
+
}
|
|
14899
|
+
}
|
|
14900
|
+
}
|
|
14901
|
+
}
|
|
14902
|
+
},
|
|
14626
14903
|
"BaseBillingEvent": {
|
|
14627
14904
|
"allOf": [
|
|
14628
14905
|
{
|
|
@@ -15492,7 +15769,7 @@
|
|
|
15492
15769
|
},
|
|
15493
15770
|
"require_password_confirmation": {
|
|
15494
15771
|
"type": "boolean",
|
|
15495
|
-
"description": "Whether the portal user must confirm their current password before the email change is handed over to the third-party system.\
|
|
15772
|
+
"description": "Whether the portal user must confirm their current password before the email change is handed over to the third-party system.\nNot required for portal users whose identity is managed by an identity provider - an SSO login has no password to confirm.\n",
|
|
15496
15773
|
"default": true
|
|
15497
15774
|
},
|
|
15498
15775
|
"explanation": {
|
|
@@ -16832,7 +17109,7 @@
|
|
|
16832
17109
|
},
|
|
16833
17110
|
"require_password_confirmation": {
|
|
16834
17111
|
"type": "boolean",
|
|
16835
|
-
"description": "Whether the portal user must confirm their current password before the change email request is handed over to the third-party system. When true, the portal collects and verifies the current password before calling the hook.
|
|
17112
|
+
"description": "Whether the portal user must confirm their current password before the change email request is handed over to the third-party system. When true, the portal collects and verifies the current password before calling the hook. Skipped for portal users whose identity is managed by an identity provider: an SSO login has no password to confirm. When no password is confirmed and `change_mode` is `synchronous`, the re-created login gets a random password and the portal user signs in through their identity provider, or sets a new password via the email code flow.\n",
|
|
16836
17113
|
"default": true
|
|
16837
17114
|
},
|
|
16838
17115
|
"explanation": {
|
package/definitions/pricing.json
CHANGED
|
@@ -5569,6 +5569,9 @@
|
|
|
5569
5569
|
"description": "When true, enables entity hydration to resolve nested $relation references in-place.",
|
|
5570
5570
|
"default": false
|
|
5571
5571
|
},
|
|
5572
|
+
"fields": {
|
|
5573
|
+
"$ref": "#/components/schemas/CatalogFieldsParam"
|
|
5574
|
+
},
|
|
5572
5575
|
"availability": {
|
|
5573
5576
|
"$ref": "#/components/schemas/AvailabilityFilters"
|
|
5574
5577
|
}
|
|
@@ -5583,6 +5586,17 @@
|
|
|
5583
5586
|
"q"
|
|
5584
5587
|
]
|
|
5585
5588
|
},
|
|
5589
|
+
"CatalogFieldsParam": {
|
|
5590
|
+
"type": "array",
|
|
5591
|
+
"description": "List of entity fields to include or exclude from the results.\n",
|
|
5592
|
+
"items": {
|
|
5593
|
+
"type": "string"
|
|
5594
|
+
},
|
|
5595
|
+
"example": [
|
|
5596
|
+
"!_files",
|
|
5597
|
+
"!**.versions"
|
|
5598
|
+
]
|
|
5599
|
+
},
|
|
5586
5600
|
"CatalogSearchResult": {
|
|
5587
5601
|
"description": "The query result payload",
|
|
5588
5602
|
"type": "object",
|
|
@@ -6,25 +6,25 @@ var _chunkS5HBBTKMcjs = require('../chunk-S5HBBTKM.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunkVBTUFDXYcjs = require('../chunk-VBTUFDXY.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/access-token.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkS5HBBTKMcjs.require_access_token_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunkVBTUFDXYcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunkVBTUFDXYcjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunkVBTUFDXYcjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunkVBTUFDXYcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
|
|
28
28
|
apiName: "accessToken"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var accessToken = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.accessToken = accessToken; exports.authorize =
|
|
38
|
+
exports.accessToken = accessToken; exports.authorize = _chunkVBTUFDXYcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|
|
@@ -6,25 +6,25 @@ var _chunkLKRBFBFNcjs = require('../chunk-LKRBFBFN.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunkVBTUFDXYcjs = require('../chunk-VBTUFDXY.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/address-suggestions.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkLKRBFBFNcjs.require_address_suggestions_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunkVBTUFDXYcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunkVBTUFDXYcjs.createApiClient.call(void 0, { definition: def, apiName: "addressSuggestions" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunkVBTUFDXYcjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunkVBTUFDXYcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "addressSuggestions" }),
|
|
28
28
|
apiName: "addressSuggestions"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var addressSuggestions = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.addressSuggestions = addressSuggestions; exports.authorize =
|
|
38
|
+
exports.addressSuggestions = addressSuggestions; exports.authorize = _chunkVBTUFDXYcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|
package/dist/apis/address.cjs
CHANGED
|
@@ -6,25 +6,25 @@ var _chunkT67ZXTVGcjs = require('../chunk-T67ZXTVG.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunkVBTUFDXYcjs = require('../chunk-VBTUFDXY.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/address.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkT67ZXTVGcjs.require_address_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunkVBTUFDXYcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunkVBTUFDXYcjs.createApiClient.call(void 0, { definition: def, apiName: "address" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunkVBTUFDXYcjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunkVBTUFDXYcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "address" }),
|
|
28
28
|
apiName: "address"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var address = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.address = address; exports.authorize =
|
|
38
|
+
exports.address = address; exports.authorize = _chunkVBTUFDXYcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|