@epilot/sdk 2.11.3 → 2.11.5
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 +148 -0
- package/definitions/snapshot-runtime.json +1 -1
- package/definitions/snapshot.json +214 -46
- 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.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 +8 -8
- package/dist/apis/snapshot.d.cts +2 -2
- package/dist/apis/snapshot.d.ts +2 -2
- package/dist/apis/snapshot.js +2 -2
- 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-4H2KIKGL.cjs +14 -0
- package/dist/{chunk-665MWZOX.cjs → chunk-6CTW57LR.cjs} +4 -4
- package/dist/chunk-COASF7ZR.js +14 -0
- package/dist/{chunk-2EYCMVMS.js → chunk-IINIFIYG.js} +4 -4
- package/dist/{chunk-54QNWEPZ.js → chunk-UXY7SWNP.js} +1 -1
- package/dist/{chunk-YXJ4PBFQ.cjs → chunk-VDMPIKAN.cjs} +1 -1
- package/dist/customer-portal-F45XWLIO.cjs +7 -0
- package/dist/customer-portal-MYNJZ4OW.js +7 -0
- package/dist/{customer-portal-runtime-C6ZIKX2V.js → customer-portal-runtime-NRIQG6IO.js} +1 -1
- package/dist/{customer-portal-runtime-M7O3RDJ5.cjs → customer-portal-runtime-VRGCSOVU.cjs} +2 -2
- package/dist/{customer-portal.d-dgnYw5xb.d.cts → customer-portal.d-fWVl8_mE.d.cts} +101 -0
- package/dist/{customer-portal.d-dgnYw5xb.d.ts → customer-portal.d-fWVl8_mE.d.ts} +101 -0
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- package/dist/js-yaml-DLCVPJ7G.js +0 -0
- package/dist/snapshot-5XHTEB2U.js +7 -0
- package/dist/snapshot-NKK6BNQB.cjs +7 -0
- package/dist/{snapshot-runtime-6DV42FVY.cjs → snapshot-runtime-AQJSSXRV.cjs} +2 -2
- package/dist/{snapshot-runtime-IW57MINC.js → snapshot-runtime-AY7YYSFQ.js} +1 -1
- package/dist/{snapshot.d-CqefmvuB.d.cts → snapshot.d-DT0zg2CS.d.cts} +258 -39
- package/dist/{snapshot.d-CqefmvuB.d.ts → snapshot.d-DT0zg2CS.d.ts} +258 -39
- package/docs/customer-portal.md +780 -216
- package/docs/snapshot.md +179 -21
- package/package.json +11 -12
- package/definitions/focus-pocus-runtime.json +0 -1
- package/definitions/focus-pocus.json +0 -757
- package/dist/chunk-JBPITLKN.cjs +0 -14
- package/dist/chunk-LSMVZMBY.js +0 -14
- package/dist/customer-portal-BMRUBRLZ.js +0 -7
- package/dist/customer-portal-PCVNGORX.cjs +0 -7
- package/dist/snapshot-2HFERXRQ.js +0 -7
- package/dist/snapshot-UHCQAT4R.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]]],["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],["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",[["language","q"]]],["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],["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]]}}
|
|
@@ -480,6 +480,142 @@
|
|
|
480
480
|
}
|
|
481
481
|
}
|
|
482
482
|
},
|
|
483
|
+
"/v1/portal/exports": {
|
|
484
|
+
"post": {
|
|
485
|
+
"operationId": "createExport",
|
|
486
|
+
"summary": "createExport",
|
|
487
|
+
"description": "Request an asynchronous CSV export of the portal user's contracts, delivery points and meters. Returns a job id to poll.",
|
|
488
|
+
"tags": [
|
|
489
|
+
"ECP"
|
|
490
|
+
],
|
|
491
|
+
"parameters": [
|
|
492
|
+
{
|
|
493
|
+
"in": "query",
|
|
494
|
+
"name": "language",
|
|
495
|
+
"required": false,
|
|
496
|
+
"schema": {
|
|
497
|
+
"type": "string",
|
|
498
|
+
"enum": [
|
|
499
|
+
"de",
|
|
500
|
+
"en"
|
|
501
|
+
]
|
|
502
|
+
},
|
|
503
|
+
"description": "Output language for headers and value formatting. Defaults to German when omitted or unsupported."
|
|
504
|
+
}
|
|
505
|
+
],
|
|
506
|
+
"security": [
|
|
507
|
+
{
|
|
508
|
+
"PortalAuth": []
|
|
509
|
+
}
|
|
510
|
+
],
|
|
511
|
+
"responses": {
|
|
512
|
+
"202": {
|
|
513
|
+
"description": "Export job accepted.",
|
|
514
|
+
"content": {
|
|
515
|
+
"application/json": {
|
|
516
|
+
"schema": {
|
|
517
|
+
"type": "object",
|
|
518
|
+
"properties": {
|
|
519
|
+
"jobId": {
|
|
520
|
+
"type": "string"
|
|
521
|
+
},
|
|
522
|
+
"status": {
|
|
523
|
+
"type": "string",
|
|
524
|
+
"enum": [
|
|
525
|
+
"queued",
|
|
526
|
+
"running",
|
|
527
|
+
"ready",
|
|
528
|
+
"failed"
|
|
529
|
+
]
|
|
530
|
+
}
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
}
|
|
534
|
+
}
|
|
535
|
+
},
|
|
536
|
+
"401": {
|
|
537
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
538
|
+
},
|
|
539
|
+
"403": {
|
|
540
|
+
"$ref": "#/components/responses/Forbidden"
|
|
541
|
+
},
|
|
542
|
+
"404": {
|
|
543
|
+
"description": "No export profile configured for this organization."
|
|
544
|
+
},
|
|
545
|
+
"500": {
|
|
546
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
547
|
+
}
|
|
548
|
+
}
|
|
549
|
+
}
|
|
550
|
+
},
|
|
551
|
+
"/v1/portal/exports/{jobId}": {
|
|
552
|
+
"get": {
|
|
553
|
+
"operationId": "getExport",
|
|
554
|
+
"summary": "getExport",
|
|
555
|
+
"description": "Get the status of an export job, including the download URL once ready.",
|
|
556
|
+
"tags": [
|
|
557
|
+
"ECP"
|
|
558
|
+
],
|
|
559
|
+
"parameters": [
|
|
560
|
+
{
|
|
561
|
+
"in": "path",
|
|
562
|
+
"name": "jobId",
|
|
563
|
+
"required": true,
|
|
564
|
+
"schema": {
|
|
565
|
+
"type": "string"
|
|
566
|
+
},
|
|
567
|
+
"description": "The export job id returned by createExport."
|
|
568
|
+
}
|
|
569
|
+
],
|
|
570
|
+
"security": [
|
|
571
|
+
{
|
|
572
|
+
"PortalAuth": []
|
|
573
|
+
}
|
|
574
|
+
],
|
|
575
|
+
"responses": {
|
|
576
|
+
"200": {
|
|
577
|
+
"description": "Export job status.",
|
|
578
|
+
"content": {
|
|
579
|
+
"application/json": {
|
|
580
|
+
"schema": {
|
|
581
|
+
"type": "object",
|
|
582
|
+
"properties": {
|
|
583
|
+
"jobId": {
|
|
584
|
+
"type": "string"
|
|
585
|
+
},
|
|
586
|
+
"status": {
|
|
587
|
+
"type": "string",
|
|
588
|
+
"enum": [
|
|
589
|
+
"queued",
|
|
590
|
+
"running",
|
|
591
|
+
"ready",
|
|
592
|
+
"failed",
|
|
593
|
+
"expired"
|
|
594
|
+
]
|
|
595
|
+
},
|
|
596
|
+
"downloadUrl": {
|
|
597
|
+
"type": "string"
|
|
598
|
+
},
|
|
599
|
+
"error": {
|
|
600
|
+
"type": "string"
|
|
601
|
+
}
|
|
602
|
+
}
|
|
603
|
+
}
|
|
604
|
+
}
|
|
605
|
+
}
|
|
606
|
+
},
|
|
607
|
+
"401": {
|
|
608
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
609
|
+
},
|
|
610
|
+
"404": {
|
|
611
|
+
"description": "Export job not found."
|
|
612
|
+
},
|
|
613
|
+
"500": {
|
|
614
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
615
|
+
}
|
|
616
|
+
}
|
|
617
|
+
}
|
|
618
|
+
},
|
|
483
619
|
"/v2/portal/extensions": {
|
|
484
620
|
"get": {
|
|
485
621
|
"operationId": "getPortalExtensions",
|
|
@@ -2929,6 +3065,10 @@
|
|
|
2929
3065
|
},
|
|
2930
3066
|
"is_main_entity": {
|
|
2931
3067
|
"type": "boolean"
|
|
3068
|
+
},
|
|
3069
|
+
"journey_registration_email": {
|
|
3070
|
+
"type": "string",
|
|
3071
|
+
"description": "The email address registered in the journey's Login & Registration block"
|
|
2932
3072
|
}
|
|
2933
3073
|
}
|
|
2934
3074
|
}
|
|
@@ -11624,6 +11764,10 @@
|
|
|
11624
11764
|
"CommonConfigAttributes": {
|
|
11625
11765
|
"type": "object",
|
|
11626
11766
|
"properties": {
|
|
11767
|
+
"mobile_config": {
|
|
11768
|
+
"description": "Mobile app configuration (top-level; moved out of the config blob).",
|
|
11769
|
+
"$ref": "#/components/schemas/MobileConfig"
|
|
11770
|
+
},
|
|
11627
11771
|
"enabled": {
|
|
11628
11772
|
"type": "boolean",
|
|
11629
11773
|
"description": "Enable/Disable the portal access"
|
|
@@ -17814,6 +17958,10 @@
|
|
|
17814
17958
|
"CommonConfigAttributesV3": {
|
|
17815
17959
|
"type": "object",
|
|
17816
17960
|
"properties": {
|
|
17961
|
+
"mobile_config": {
|
|
17962
|
+
"description": "Mobile app configuration (top-level; moved out of the config blob).",
|
|
17963
|
+
"$ref": "#/components/schemas/MobileConfig"
|
|
17964
|
+
},
|
|
17817
17965
|
"enabled": {
|
|
17818
17966
|
"type": "boolean",
|
|
17819
17967
|
"description": "Enable/Disable the portal access"
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"s":"https://snapshot.sls.epilot.io","o":[["createSnapshot","post","/v1/snapshots",null,1],["listSnapshots","get","/v1/snapshots",[["cursor","q"],["size","q"],["resource","q"],["trigger","q"]]],["captureOrgSnapshot","post","/v1/snapshots:capture-org",null,1],["getSnapshot","get","/v1/snapshots/{id}"],["deleteSnapshot","delete","/v1/snapshots/{id}"],["restoreSnapshot","post","/v1/snapshots/{id}:restore",null,1],["listSnapshotResources","get","/v1/snapshots/{id}/resources"],["getSnapshotResource","get","/v1/snapshots/{id}/resources/{lineage_id}"],["listDependencies","post","/v1/snapshots:list-dependencies",null,1]],"v":"3.0.3","pp":{"/v1/snapshots/{id}":[["id","p",true]],"/v1/snapshots/{id}:restore":[["id","p",true]],"/v1/snapshots/{id}/resources":[["id","p",true]],"/v1/snapshots/{id}/resources/{lineage_id}":[["id","p",true],["lineage_id","p",true]]}}
|
|
1
|
+
{"s":"https://snapshot.sls.epilot.io","o":[["createSnapshot","post","/v1/snapshots",null,1],["listSnapshots","get","/v1/snapshots",[["cursor","q"],["size","q"],["resource","q"],["trigger","q"]]],["captureOrgSnapshot","post","/v1/snapshots:capture-org",null,1],["getSnapshot","get","/v1/snapshots/{id}"],["deleteSnapshot","delete","/v1/snapshots/{id}"],["restoreSnapshot","post","/v1/snapshots/{id}:restore",null,1],["listSnapshotResources","get","/v1/snapshots/{id}/resources"],["getSnapshotResource","get","/v1/snapshots/{id}/resources/{lineage_id}"],["getOrgSnapshotSchedule","get","/v1/org-snapshot-schedule"],["putOrgSnapshotSchedule","put","/v1/org-snapshot-schedule",null,1],["deleteOrgSnapshotSchedule","delete","/v1/org-snapshot-schedule"],["listDependencies","post","/v1/snapshots:list-dependencies",null,1]],"v":"3.0.3","pp":{"/v1/snapshots/{id}":[["id","p",true]],"/v1/snapshots/{id}:restore":[["id","p",true]],"/v1/snapshots/{id}/resources":[["id","p",true]],"/v1/snapshots/{id}/resources/{lineage_id}":[["id","p",true],["lineage_id","p",true]]}}
|
|
@@ -27,6 +27,10 @@
|
|
|
27
27
|
{
|
|
28
28
|
"name": "Snapshots",
|
|
29
29
|
"description": "Snapshot CRUD and restore operations"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "ScheduledSnapshots",
|
|
33
|
+
"description": "Enrollment and configuration for scheduled org snapshots"
|
|
30
34
|
}
|
|
31
35
|
],
|
|
32
36
|
"paths": {
|
|
@@ -160,7 +164,7 @@
|
|
|
160
164
|
"post": {
|
|
161
165
|
"operationId": "captureOrgSnapshot",
|
|
162
166
|
"summary": "captureOrgSnapshot",
|
|
163
|
-
"description": "Snapshot the caller's whole organization now.
|
|
167
|
+
"description": "Snapshot the caller's whole organization now. Creates a `scope: \"org\"`\nsnapshot row and starts a chunked capture Step Function, then returns\nimmediately. The capture asynchronously fetches a fresh inventory of the\norg's configuration resources from configuration-hub-api, persists it as\nan inventory artifact, and captures each resource. Client polls\n`getSnapshot` and watches `capture_summary` fill in until `create.status`\nmoves from `in_progress` to `completed` or `failed`. An org with no\ncapturable resources finalizes as a completed 0-resource snapshot.\n\nSensitive types (`access_token`, `environment_variable`), types with no\nengine adapter, and any `excluded_types` are dropped from the capture and\nrecorded in the snapshot's coverage report.\n",
|
|
164
168
|
"tags": [
|
|
165
169
|
"Snapshots"
|
|
166
170
|
],
|
|
@@ -187,9 +191,6 @@
|
|
|
187
191
|
},
|
|
188
192
|
"401": {
|
|
189
193
|
"$ref": "#/components/responses/Unauthorized"
|
|
190
|
-
},
|
|
191
|
-
"422": {
|
|
192
|
-
"$ref": "#/components/responses/UnprocessableEntity"
|
|
193
194
|
}
|
|
194
195
|
}
|
|
195
196
|
}
|
|
@@ -383,6 +384,89 @@
|
|
|
383
384
|
}
|
|
384
385
|
}
|
|
385
386
|
},
|
|
387
|
+
"/v1/org-snapshot-schedule": {
|
|
388
|
+
"get": {
|
|
389
|
+
"operationId": "getOrgSnapshotSchedule",
|
|
390
|
+
"summary": "getOrgSnapshotSchedule",
|
|
391
|
+
"description": "Return the scheduled-snapshot enrollment config for the caller's org.\nReturns 404 when the org has not yet enrolled.\n",
|
|
392
|
+
"tags": [
|
|
393
|
+
"ScheduledSnapshots"
|
|
394
|
+
],
|
|
395
|
+
"responses": {
|
|
396
|
+
"200": {
|
|
397
|
+
"description": "Org snapshot schedule config",
|
|
398
|
+
"content": {
|
|
399
|
+
"application/json": {
|
|
400
|
+
"schema": {
|
|
401
|
+
"$ref": "#/components/schemas/OrgSnapshotSchedule"
|
|
402
|
+
}
|
|
403
|
+
}
|
|
404
|
+
}
|
|
405
|
+
},
|
|
406
|
+
"401": {
|
|
407
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
408
|
+
},
|
|
409
|
+
"404": {
|
|
410
|
+
"$ref": "#/components/responses/NotFound"
|
|
411
|
+
}
|
|
412
|
+
}
|
|
413
|
+
},
|
|
414
|
+
"put": {
|
|
415
|
+
"operationId": "putOrgSnapshotSchedule",
|
|
416
|
+
"summary": "putOrgSnapshotSchedule",
|
|
417
|
+
"description": "Create or update the scheduled-snapshot enrollment config for the\ncaller's org (upsert). The cron expression and retention window are\nvalidated server-side; invalid values are rejected with 400.\n\nDefaults applied when a field is omitted on first create:\n - `cron_expression`: `cron(0 2 * * ? *)` (daily at 02:00)\n - `timezone`: `Europe/Berlin`\n - `retention`: `{ value: 90, unit: \"days\" }`\n - `enabled`: `true`\n\n**Note:** this call persists the row only. EventBridge schedule\nmaterialization is performed by a subsequent reconcile step (Task 6).\nThe row is the authoritative source of truth for the UI.\n",
|
|
418
|
+
"tags": [
|
|
419
|
+
"ScheduledSnapshots"
|
|
420
|
+
],
|
|
421
|
+
"requestBody": {
|
|
422
|
+
"required": false,
|
|
423
|
+
"content": {
|
|
424
|
+
"application/json": {
|
|
425
|
+
"schema": {
|
|
426
|
+
"$ref": "#/components/schemas/PutOrgSnapshotScheduleRequest"
|
|
427
|
+
}
|
|
428
|
+
}
|
|
429
|
+
}
|
|
430
|
+
},
|
|
431
|
+
"responses": {
|
|
432
|
+
"200": {
|
|
433
|
+
"description": "Stored config (after upsert)",
|
|
434
|
+
"content": {
|
|
435
|
+
"application/json": {
|
|
436
|
+
"schema": {
|
|
437
|
+
"$ref": "#/components/schemas/OrgSnapshotSchedule"
|
|
438
|
+
}
|
|
439
|
+
}
|
|
440
|
+
}
|
|
441
|
+
},
|
|
442
|
+
"400": {
|
|
443
|
+
"$ref": "#/components/responses/BadRequest"
|
|
444
|
+
},
|
|
445
|
+
"401": {
|
|
446
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
447
|
+
}
|
|
448
|
+
}
|
|
449
|
+
},
|
|
450
|
+
"delete": {
|
|
451
|
+
"operationId": "deleteOrgSnapshotSchedule",
|
|
452
|
+
"summary": "deleteOrgSnapshotSchedule",
|
|
453
|
+
"description": "Remove the scheduled-snapshot enrollment for the caller's org.\nReturns 404 when no schedule exists.\nThe corresponding EventBridge schedule is removed by a reconcile\nstep (Task 6).\n",
|
|
454
|
+
"tags": [
|
|
455
|
+
"ScheduledSnapshots"
|
|
456
|
+
],
|
|
457
|
+
"responses": {
|
|
458
|
+
"204": {
|
|
459
|
+
"description": "Deleted"
|
|
460
|
+
},
|
|
461
|
+
"401": {
|
|
462
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
463
|
+
},
|
|
464
|
+
"404": {
|
|
465
|
+
"$ref": "#/components/responses/NotFound"
|
|
466
|
+
}
|
|
467
|
+
}
|
|
468
|
+
}
|
|
469
|
+
},
|
|
386
470
|
"/v1/snapshots:list-dependencies": {
|
|
387
471
|
"post": {
|
|
388
472
|
"operationId": "listDependencies",
|
|
@@ -489,16 +573,6 @@
|
|
|
489
573
|
}
|
|
490
574
|
}
|
|
491
575
|
}
|
|
492
|
-
},
|
|
493
|
-
"UnprocessableEntity": {
|
|
494
|
-
"description": "Unprocessable entity",
|
|
495
|
-
"content": {
|
|
496
|
-
"application/json": {
|
|
497
|
-
"schema": {
|
|
498
|
-
"$ref": "#/components/schemas/EmptyInventoryError"
|
|
499
|
-
}
|
|
500
|
-
}
|
|
501
|
-
}
|
|
502
576
|
}
|
|
503
577
|
},
|
|
504
578
|
"schemas": {
|
|
@@ -517,38 +591,6 @@
|
|
|
517
591
|
}
|
|
518
592
|
}
|
|
519
593
|
},
|
|
520
|
-
"EmptyInventoryError": {
|
|
521
|
-
"type": "object",
|
|
522
|
-
"required": [
|
|
523
|
-
"message",
|
|
524
|
-
"skipped_types"
|
|
525
|
-
],
|
|
526
|
-
"description": "Returned (422) when the org inventory contains no capturable resources\nafter filtering out sensitive, unsupported, and excluded types. The\n`skipped_types` array explains why every type was dropped.\n",
|
|
527
|
-
"properties": {
|
|
528
|
-
"message": {
|
|
529
|
-
"type": "string",
|
|
530
|
-
"example": "No capturable resources in the org inventory"
|
|
531
|
-
},
|
|
532
|
-
"skipped_types": {
|
|
533
|
-
"type": "array",
|
|
534
|
-
"items": {
|
|
535
|
-
"type": "object",
|
|
536
|
-
"required": [
|
|
537
|
-
"type",
|
|
538
|
-
"reason"
|
|
539
|
-
],
|
|
540
|
-
"properties": {
|
|
541
|
-
"type": {
|
|
542
|
-
"type": "string"
|
|
543
|
-
},
|
|
544
|
-
"reason": {
|
|
545
|
-
"type": "string"
|
|
546
|
-
}
|
|
547
|
-
}
|
|
548
|
-
}
|
|
549
|
-
}
|
|
550
|
-
}
|
|
551
|
-
},
|
|
552
594
|
"ResourceRef": {
|
|
553
595
|
"type": "object",
|
|
554
596
|
"required": [
|
|
@@ -929,6 +971,132 @@
|
|
|
929
971
|
"type": "string"
|
|
930
972
|
}
|
|
931
973
|
}
|
|
974
|
+
},
|
|
975
|
+
"RetentionConfig": {
|
|
976
|
+
"type": "object",
|
|
977
|
+
"required": [
|
|
978
|
+
"value",
|
|
979
|
+
"unit"
|
|
980
|
+
],
|
|
981
|
+
"description": "Flat retention window for a scheduled snapshot.\nConverted to a `ttl` epoch at capture time. Capped at ~24 months.\n",
|
|
982
|
+
"properties": {
|
|
983
|
+
"value": {
|
|
984
|
+
"type": "integer",
|
|
985
|
+
"minimum": 1,
|
|
986
|
+
"description": "Numeric quantity of retention (e.g. 90 for \"90 days\")."
|
|
987
|
+
},
|
|
988
|
+
"unit": {
|
|
989
|
+
"type": "string",
|
|
990
|
+
"enum": [
|
|
991
|
+
"days",
|
|
992
|
+
"weeks",
|
|
993
|
+
"months"
|
|
994
|
+
]
|
|
995
|
+
}
|
|
996
|
+
}
|
|
997
|
+
},
|
|
998
|
+
"PutOrgSnapshotScheduleRequest": {
|
|
999
|
+
"type": "object",
|
|
1000
|
+
"description": "Body for `putOrgSnapshotSchedule`. All fields optional; unset fields\nreceive defaults on first create and are left unchanged on updates\n(except `updated_at`).\n",
|
|
1001
|
+
"properties": {
|
|
1002
|
+
"enabled": {
|
|
1003
|
+
"type": "boolean",
|
|
1004
|
+
"default": true,
|
|
1005
|
+
"description": "Whether the schedule is active."
|
|
1006
|
+
},
|
|
1007
|
+
"cron_expression": {
|
|
1008
|
+
"type": "string",
|
|
1009
|
+
"description": "6-field EventBridge cron expression, e.g. `cron(0 2 * * ? *)`.\nValidated server-side: minute + hour must be concrete single integers\n(no `*`, lists, ranges, or steps) to cap cadence at ≤ once/day.\nExactly one of day-of-month / day-of-week must be `?`.\n",
|
|
1010
|
+
"example": "cron(0 2 * * ? *)"
|
|
1011
|
+
},
|
|
1012
|
+
"timezone": {
|
|
1013
|
+
"type": "string",
|
|
1014
|
+
"description": "IANA timezone string passed to EventBridge `ScheduleExpressionTimezone`,\ne.g. `Europe/Berlin`. AWS handles DST natively.\n",
|
|
1015
|
+
"example": "Europe/Berlin"
|
|
1016
|
+
},
|
|
1017
|
+
"retention": {
|
|
1018
|
+
"$ref": "#/components/schemas/RetentionConfig"
|
|
1019
|
+
},
|
|
1020
|
+
"excluded_types": {
|
|
1021
|
+
"type": "array",
|
|
1022
|
+
"description": "Resource types to exclude from the scheduled capture, in addition\nto the always-excluded sensitive types (`access_token`,\n`environment_variable`).\n",
|
|
1023
|
+
"items": {
|
|
1024
|
+
"type": "string"
|
|
1025
|
+
}
|
|
1026
|
+
}
|
|
1027
|
+
}
|
|
1028
|
+
},
|
|
1029
|
+
"OrgSnapshotSchedule": {
|
|
1030
|
+
"type": "object",
|
|
1031
|
+
"required": [
|
|
1032
|
+
"org_id",
|
|
1033
|
+
"enabled",
|
|
1034
|
+
"cron_expression",
|
|
1035
|
+
"timezone",
|
|
1036
|
+
"retention",
|
|
1037
|
+
"schedule_name",
|
|
1038
|
+
"created_by",
|
|
1039
|
+
"created_at",
|
|
1040
|
+
"updated_at"
|
|
1041
|
+
],
|
|
1042
|
+
"description": "Enrollment record for a scheduled org snapshot. One row per org.\nThis table — not EventBridge — is the source of truth; the EventBridge\nschedule entry is the materialization of this row (reconciled on write\nby Task 6).\n",
|
|
1043
|
+
"properties": {
|
|
1044
|
+
"org_id": {
|
|
1045
|
+
"type": "string"
|
|
1046
|
+
},
|
|
1047
|
+
"enabled": {
|
|
1048
|
+
"type": "boolean"
|
|
1049
|
+
},
|
|
1050
|
+
"cron_expression": {
|
|
1051
|
+
"type": "string",
|
|
1052
|
+
"description": "Validated 6-field EventBridge cron. Default `cron(0 2 * * ? *)`.",
|
|
1053
|
+
"example": "cron(0 2 * * ? *)"
|
|
1054
|
+
},
|
|
1055
|
+
"timezone": {
|
|
1056
|
+
"type": "string",
|
|
1057
|
+
"description": "IANA timezone. Default `Europe/Berlin`."
|
|
1058
|
+
},
|
|
1059
|
+
"retention": {
|
|
1060
|
+
"$ref": "#/components/schemas/RetentionConfig"
|
|
1061
|
+
},
|
|
1062
|
+
"excluded_types": {
|
|
1063
|
+
"type": "array",
|
|
1064
|
+
"items": {
|
|
1065
|
+
"type": "string"
|
|
1066
|
+
}
|
|
1067
|
+
},
|
|
1068
|
+
"schedule_name": {
|
|
1069
|
+
"type": "string",
|
|
1070
|
+
"description": "Name of the EventBridge Scheduler entry this row owns.\nSet at enrollment time as `org-snapshot-{orgId}`.\n"
|
|
1071
|
+
},
|
|
1072
|
+
"last_started_at": {
|
|
1073
|
+
"type": "string",
|
|
1074
|
+
"format": "date-time"
|
|
1075
|
+
},
|
|
1076
|
+
"last_completed_at": {
|
|
1077
|
+
"type": "string",
|
|
1078
|
+
"format": "date-time"
|
|
1079
|
+
},
|
|
1080
|
+
"last_status": {
|
|
1081
|
+
"type": "string",
|
|
1082
|
+
"enum": [
|
|
1083
|
+
"completed",
|
|
1084
|
+
"partial",
|
|
1085
|
+
"failed"
|
|
1086
|
+
]
|
|
1087
|
+
},
|
|
1088
|
+
"created_by": {
|
|
1089
|
+
"type": "string"
|
|
1090
|
+
},
|
|
1091
|
+
"created_at": {
|
|
1092
|
+
"type": "string",
|
|
1093
|
+
"format": "date-time"
|
|
1094
|
+
},
|
|
1095
|
+
"updated_at": {
|
|
1096
|
+
"type": "string",
|
|
1097
|
+
"format": "date-time"
|
|
1098
|
+
}
|
|
1099
|
+
}
|
|
932
1100
|
}
|
|
933
1101
|
}
|
|
934
1102
|
}
|
|
@@ -6,25 +6,25 @@ var _chunkS5HBBTKMcjs = require('../chunk-S5HBBTKM.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunk6CTW57LRcjs = require('../chunk-6CTW57LR.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 _chunk6CTW57LRcjs.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 = _chunk6CTW57LRcjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunk6CTW57LRcjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunk6CTW57LRcjs.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 = _chunk6CTW57LRcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|