{ "openapi": "3.1.0", "info": { "title": "Darpan Facade API", "version": "2.1.2", "x-darpan-contract-version": 1, "description": "GENERATED from the facade service XML \u2014 do not edit by hand. Regenerate with ./gradlew :runtime:component:darpan:generateApiContract.\n\nTransport: JSON-RPC 2.0 over POST /rpc/json. Auth channels: browser SPA uses the HttpOnly darpan_login_key cookie + CSRF token (canonical); integration callers and no-credentialed-CORS fallbacks use the login_key header (in-memory only, never query params). HTTP status is 200 for every dispatched call; distinguish outcomes by shape. JSON-RPC error object: protocol failures (-32700 parse, -32600 invalid request, -32601 method not found, -32602 invalid params), unhandled service errors (code 500), authorization denial (code 403). Facade business validation instead returns a success envelope with result.ok=false and result.errors[]." }, "servers": [ { "url": "/", "description": "Same-origin Moqui backend (api.drpn.ai in production)" } ], "paths": { "/rpc/json": { "post": { "operationId": "jsonRpcCall", "summary": "Single JSON-RPC endpoint for all Darpan facade methods", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChangeOwnPasswordRequest" }, { "$ref": "#/components/schemas/GetSessionInfoRequest" }, { "$ref": "#/components/schemas/LoginSessionRequest" }, { "$ref": "#/components/schemas/LogoutAllSessionsRequest" }, { "$ref": "#/components/schemas/LogoutSessionRequest" }, { "$ref": "#/components/schemas/SaveActiveTenantRequest" }, { "$ref": "#/components/schemas/SaveUserSettingsRequest" }, { "$ref": "#/components/schemas/VerifyOwnPasswordRequest" }, { "$ref": "#/components/schemas/DeleteHotWaxOmsRestSourceConfigRequest" }, { "$ref": "#/components/schemas/ListHotWaxOmsRestSourceConfigsRequest" }, { "$ref": "#/components/schemas/SaveHotWaxOmsRestSourceConfigRequest" }, { "$ref": "#/components/schemas/DeleteJsonSchemaRequest" }, { "$ref": "#/components/schemas/FlattenJsonSchemaRequest" }, { "$ref": "#/components/schemas/GetJsonSchemaRequest" }, { "$ref": "#/components/schemas/InferJsonSchemaFromTextRequest" }, { "$ref": "#/components/schemas/ListJsonSchemasRequest" }, { "$ref": "#/components/schemas/SaveJsonSchemaTextRequest" }, { "$ref": "#/components/schemas/SaveRefinedSchemaRequest" }, { "$ref": "#/components/schemas/ValidateJsonTextAgainstSchemaRequest" }, { "$ref": "#/components/schemas/CreateCsvRunRequest" }, { "$ref": "#/components/schemas/CreateMappingRequest" }, { "$ref": "#/components/schemas/CreateRuleSetRunRequest" }, { "$ref": "#/components/schemas/DeleteAutomationRequest" }, { "$ref": "#/components/schemas/DeleteGeneratedOutputRequest" }, { "$ref": "#/components/schemas/DeleteSavedRunRequest" }, { "$ref": "#/components/schemas/GetAutomationRequest" }, { "$ref": "#/components/schemas/GetGeneratedOutputRequest" }, { "$ref": "#/components/schemas/GetGeneratedOutputDifferencesRequest" }, { "$ref": "#/components/schemas/GetMappingRequest" }, { "$ref": "#/components/schemas/ListAutomationExecutionsRequest" }, { "$ref": "#/components/schemas/ListAutomationSourceOptionsRequest" }, { "$ref": "#/components/schemas/ListAutomationsRequest" }, { "$ref": "#/components/schemas/ListGeneratedOutputsRequest" }, { "$ref": "#/components/schemas/ListMappingsRequest" }, { "$ref": "#/components/schemas/ListSavedRunsRequest" }, { "$ref": "#/components/schemas/PauseAutomationRequest" }, { "$ref": "#/components/schemas/ReprocessAutomationExecutionRequest" }, { "$ref": "#/components/schemas/ResumeAutomationRequest" }, { "$ref": "#/components/schemas/RunAutomationNowRequest" }, { "$ref": "#/components/schemas/RunGenericDiffRequest" }, { "$ref": "#/components/schemas/RunSavedRunDiffRequest" }, { "$ref": "#/components/schemas/SaveAutomationRequest" }, { "$ref": "#/components/schemas/SaveDashboardPinnedMappingsRequest" }, { "$ref": "#/components/schemas/SaveDashboardPinnedSavedRunsRequest" }, { "$ref": "#/components/schemas/SaveMappingRequest" }, { "$ref": "#/components/schemas/SaveRuleSetRunRequest" }, { "$ref": "#/components/schemas/SaveSavedRunNameRequest" }, { "$ref": "#/components/schemas/SearchNavigationTargetsRequest" }, { "$ref": "#/components/schemas/GetLlmSettingsRequest" }, { "$ref": "#/components/schemas/GetTenantNotificationSettingsRequest" }, { "$ref": "#/components/schemas/GetTenantSettingsRequest" }, { "$ref": "#/components/schemas/ListEnumOptionsRequest" }, { "$ref": "#/components/schemas/ListNsAuthConfigsRequest" }, { "$ref": "#/components/schemas/ListNsRestletConfigsRequest" }, { "$ref": "#/components/schemas/ListSftpServersRequest" }, { "$ref": "#/components/schemas/SaveLlmSettingsRequest" }, { "$ref": "#/components/schemas/SaveNsAuthConfigRequest" }, { "$ref": "#/components/schemas/SaveNsRestletConfigRequest" }, { "$ref": "#/components/schemas/SaveSftpServerRequest" }, { "$ref": "#/components/schemas/SaveTenantNotificationSettingsRequest" }, { "$ref": "#/components/schemas/SaveTenantSettingsRequest" }, { "$ref": "#/components/schemas/DeleteShopifyAuthConfigRequest" }, { "$ref": "#/components/schemas/GetShopifyAuthConfigRequest" }, { "$ref": "#/components/schemas/ListShopifyAuthConfigsRequest" }, { "$ref": "#/components/schemas/SaveShopifyAuthConfigRequest" } ], "discriminator": { "propertyName": "method", "mapping": { "facade.AuthFacadeServices.change#OwnPassword": "#/components/schemas/ChangeOwnPasswordRequest", "facade.AuthFacadeServices.get#SessionInfo": "#/components/schemas/GetSessionInfoRequest", "facade.AuthFacadeServices.login#Session": "#/components/schemas/LoginSessionRequest", "facade.AuthFacadeServices.logout#AllSessions": "#/components/schemas/LogoutAllSessionsRequest", "facade.AuthFacadeServices.logout#Session": "#/components/schemas/LogoutSessionRequest", "facade.AuthFacadeServices.save#ActiveTenant": "#/components/schemas/SaveActiveTenantRequest", "facade.AuthFacadeServices.save#UserSettings": "#/components/schemas/SaveUserSettingsRequest", "facade.AuthFacadeServices.verify#OwnPassword": "#/components/schemas/VerifyOwnPasswordRequest", "facade.HotWaxOmsFacadeServices.delete#HotWaxOmsRestSourceConfig": "#/components/schemas/DeleteHotWaxOmsRestSourceConfigRequest", "facade.HotWaxOmsFacadeServices.list#HotWaxOmsRestSourceConfigs": "#/components/schemas/ListHotWaxOmsRestSourceConfigsRequest", "facade.HotWaxOmsFacadeServices.save#HotWaxOmsRestSourceConfig": "#/components/schemas/SaveHotWaxOmsRestSourceConfigRequest", "facade.JsonSchemaFacadeServices.delete#JsonSchema": "#/components/schemas/DeleteJsonSchemaRequest", "facade.JsonSchemaFacadeServices.flatten#JsonSchema": "#/components/schemas/FlattenJsonSchemaRequest", "facade.JsonSchemaFacadeServices.get#JsonSchema": "#/components/schemas/GetJsonSchemaRequest", "facade.JsonSchemaFacadeServices.infer#JsonSchemaFromText": "#/components/schemas/InferJsonSchemaFromTextRequest", "facade.JsonSchemaFacadeServices.list#JsonSchemas": "#/components/schemas/ListJsonSchemasRequest", "facade.JsonSchemaFacadeServices.save#JsonSchemaText": "#/components/schemas/SaveJsonSchemaTextRequest", "facade.JsonSchemaFacadeServices.save#RefinedSchema": "#/components/schemas/SaveRefinedSchemaRequest", "facade.JsonSchemaFacadeServices.validate#JsonTextAgainstSchema": "#/components/schemas/ValidateJsonTextAgainstSchemaRequest", "facade.ReconciliationFacadeServices.create#CsvRun": "#/components/schemas/CreateCsvRunRequest", "facade.ReconciliationFacadeServices.create#Mapping": "#/components/schemas/CreateMappingRequest", "facade.ReconciliationFacadeServices.create#RuleSetRun": "#/components/schemas/CreateRuleSetRunRequest", "facade.ReconciliationFacadeServices.delete#Automation": "#/components/schemas/DeleteAutomationRequest", "facade.ReconciliationFacadeServices.delete#GeneratedOutput": "#/components/schemas/DeleteGeneratedOutputRequest", "facade.ReconciliationFacadeServices.delete#SavedRun": "#/components/schemas/DeleteSavedRunRequest", "facade.ReconciliationFacadeServices.get#Automation": "#/components/schemas/GetAutomationRequest", "facade.ReconciliationFacadeServices.get#GeneratedOutput": "#/components/schemas/GetGeneratedOutputRequest", "facade.ReconciliationFacadeServices.get#GeneratedOutputDifferences": "#/components/schemas/GetGeneratedOutputDifferencesRequest", "facade.ReconciliationFacadeServices.get#Mapping": "#/components/schemas/GetMappingRequest", "facade.ReconciliationFacadeServices.list#AutomationExecutions": "#/components/schemas/ListAutomationExecutionsRequest", "facade.ReconciliationFacadeServices.list#AutomationSourceOptions": "#/components/schemas/ListAutomationSourceOptionsRequest", "facade.ReconciliationFacadeServices.list#Automations": "#/components/schemas/ListAutomationsRequest", "facade.ReconciliationFacadeServices.list#GeneratedOutputs": "#/components/schemas/ListGeneratedOutputsRequest", "facade.ReconciliationFacadeServices.list#Mappings": "#/components/schemas/ListMappingsRequest", "facade.ReconciliationFacadeServices.list#SavedRuns": "#/components/schemas/ListSavedRunsRequest", "facade.ReconciliationFacadeServices.pause#Automation": "#/components/schemas/PauseAutomationRequest", "facade.ReconciliationFacadeServices.reprocess#AutomationExecution": "#/components/schemas/ReprocessAutomationExecutionRequest", "facade.ReconciliationFacadeServices.resume#Automation": "#/components/schemas/ResumeAutomationRequest", "facade.ReconciliationFacadeServices.run#AutomationNow": "#/components/schemas/RunAutomationNowRequest", "facade.ReconciliationFacadeServices.run#GenericDiff": "#/components/schemas/RunGenericDiffRequest", "facade.ReconciliationFacadeServices.run#SavedRunDiff": "#/components/schemas/RunSavedRunDiffRequest", "facade.ReconciliationFacadeServices.save#Automation": "#/components/schemas/SaveAutomationRequest", "facade.ReconciliationFacadeServices.save#DashboardPinnedMappings": "#/components/schemas/SaveDashboardPinnedMappingsRequest", "facade.ReconciliationFacadeServices.save#DashboardPinnedSavedRuns": "#/components/schemas/SaveDashboardPinnedSavedRunsRequest", "facade.ReconciliationFacadeServices.save#Mapping": "#/components/schemas/SaveMappingRequest", "facade.ReconciliationFacadeServices.save#RuleSetRun": "#/components/schemas/SaveRuleSetRunRequest", "facade.ReconciliationFacadeServices.save#SavedRunName": "#/components/schemas/SaveSavedRunNameRequest", "facade.SearchFacadeServices.search#NavigationTargets": "#/components/schemas/SearchNavigationTargetsRequest", "facade.SettingsFacadeServices.get#LlmSettings": "#/components/schemas/GetLlmSettingsRequest", "facade.SettingsFacadeServices.get#TenantNotificationSettings": "#/components/schemas/GetTenantNotificationSettingsRequest", "facade.SettingsFacadeServices.get#TenantSettings": "#/components/schemas/GetTenantSettingsRequest", "facade.SettingsFacadeServices.list#EnumOptions": "#/components/schemas/ListEnumOptionsRequest", "facade.SettingsFacadeServices.list#NsAuthConfigs": "#/components/schemas/ListNsAuthConfigsRequest", "facade.SettingsFacadeServices.list#NsRestletConfigs": "#/components/schemas/ListNsRestletConfigsRequest", "facade.SettingsFacadeServices.list#SftpServers": "#/components/schemas/ListSftpServersRequest", "facade.SettingsFacadeServices.save#LlmSettings": "#/components/schemas/SaveLlmSettingsRequest", "facade.SettingsFacadeServices.save#NsAuthConfig": "#/components/schemas/SaveNsAuthConfigRequest", "facade.SettingsFacadeServices.save#NsRestletConfig": "#/components/schemas/SaveNsRestletConfigRequest", "facade.SettingsFacadeServices.save#SftpServer": "#/components/schemas/SaveSftpServerRequest", "facade.SettingsFacadeServices.save#TenantNotificationSettings": "#/components/schemas/SaveTenantNotificationSettingsRequest", "facade.SettingsFacadeServices.save#TenantSettings": "#/components/schemas/SaveTenantSettingsRequest", "facade.ShopifyFacadeServices.delete#ShopifyAuthConfig": "#/components/schemas/DeleteShopifyAuthConfigRequest", "facade.ShopifyFacadeServices.get#ShopifyAuthConfig": "#/components/schemas/GetShopifyAuthConfigRequest", "facade.ShopifyFacadeServices.list#ShopifyAuthConfigs": "#/components/schemas/ListShopifyAuthConfigsRequest", "facade.ShopifyFacadeServices.save#ShopifyAuthConfig": "#/components/schemas/SaveShopifyAuthConfigRequest" } } } } } }, "responses": { "200": { "description": "JSON-RPC response \u2014 success envelope, or protocol error object", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/JsonRpcErrorResponse" }, { "$ref": "#/components/schemas/ChangeOwnPasswordResponse" }, { "$ref": "#/components/schemas/GetSessionInfoResponse" }, { "$ref": "#/components/schemas/LoginSessionResponse" }, { "$ref": "#/components/schemas/LogoutAllSessionsResponse" }, { "$ref": "#/components/schemas/LogoutSessionResponse" }, { "$ref": "#/components/schemas/SaveActiveTenantResponse" }, { "$ref": "#/components/schemas/SaveUserSettingsResponse" }, { "$ref": "#/components/schemas/VerifyOwnPasswordResponse" }, { "$ref": "#/components/schemas/DeleteHotWaxOmsRestSourceConfigResponse" }, { "$ref": "#/components/schemas/ListHotWaxOmsRestSourceConfigsResponse" }, { "$ref": "#/components/schemas/SaveHotWaxOmsRestSourceConfigResponse" }, { "$ref": "#/components/schemas/DeleteJsonSchemaResponse" }, { "$ref": "#/components/schemas/FlattenJsonSchemaResponse" }, { "$ref": "#/components/schemas/GetJsonSchemaResponse" }, { "$ref": "#/components/schemas/InferJsonSchemaFromTextResponse" }, { "$ref": "#/components/schemas/ListJsonSchemasResponse" }, { "$ref": "#/components/schemas/SaveJsonSchemaTextResponse" }, { "$ref": "#/components/schemas/SaveRefinedSchemaResponse" }, { "$ref": "#/components/schemas/ValidateJsonTextAgainstSchemaResponse" }, { "$ref": "#/components/schemas/CreateCsvRunResponse" }, { "$ref": "#/components/schemas/CreateMappingResponse" }, { "$ref": "#/components/schemas/CreateRuleSetRunResponse" }, { "$ref": "#/components/schemas/DeleteAutomationResponse" }, { "$ref": "#/components/schemas/DeleteGeneratedOutputResponse" }, { "$ref": "#/components/schemas/DeleteSavedRunResponse" }, { "$ref": "#/components/schemas/GetAutomationResponse" }, { "$ref": "#/components/schemas/GetGeneratedOutputResponse" }, { "$ref": "#/components/schemas/GetGeneratedOutputDifferencesResponse" }, { "$ref": "#/components/schemas/GetMappingResponse" }, { "$ref": "#/components/schemas/ListAutomationExecutionsResponse" }, { "$ref": "#/components/schemas/ListAutomationSourceOptionsResponse" }, { "$ref": "#/components/schemas/ListAutomationsResponse" }, { "$ref": "#/components/schemas/ListGeneratedOutputsResponse" }, { "$ref": "#/components/schemas/ListMappingsResponse" }, { "$ref": "#/components/schemas/ListSavedRunsResponse" }, { "$ref": "#/components/schemas/PauseAutomationResponse" }, { "$ref": "#/components/schemas/ReprocessAutomationExecutionResponse" }, { "$ref": "#/components/schemas/ResumeAutomationResponse" }, { "$ref": "#/components/schemas/RunAutomationNowResponse" }, { "$ref": "#/components/schemas/RunGenericDiffResponse" }, { "$ref": "#/components/schemas/RunSavedRunDiffResponse" }, { "$ref": "#/components/schemas/SaveAutomationResponse" }, { "$ref": "#/components/schemas/SaveDashboardPinnedMappingsResponse" }, { "$ref": "#/components/schemas/SaveDashboardPinnedSavedRunsResponse" }, { "$ref": "#/components/schemas/SaveMappingResponse" }, { "$ref": "#/components/schemas/SaveRuleSetRunResponse" }, { "$ref": "#/components/schemas/SaveSavedRunNameResponse" }, { "$ref": "#/components/schemas/SearchNavigationTargetsResponse" }, { "$ref": "#/components/schemas/GetLlmSettingsResponse" }, { "$ref": "#/components/schemas/GetTenantNotificationSettingsResponse" }, { "$ref": "#/components/schemas/GetTenantSettingsResponse" }, { "$ref": "#/components/schemas/ListEnumOptionsResponse" }, { "$ref": "#/components/schemas/ListNsAuthConfigsResponse" }, { "$ref": "#/components/schemas/ListNsRestletConfigsResponse" }, { "$ref": "#/components/schemas/ListSftpServersResponse" }, { "$ref": "#/components/schemas/SaveLlmSettingsResponse" }, { "$ref": "#/components/schemas/SaveNsAuthConfigResponse" }, { "$ref": "#/components/schemas/SaveNsRestletConfigResponse" }, { "$ref": "#/components/schemas/SaveSftpServerResponse" }, { "$ref": "#/components/schemas/SaveTenantNotificationSettingsResponse" }, { "$ref": "#/components/schemas/SaveTenantSettingsResponse" }, { "$ref": "#/components/schemas/DeleteShopifyAuthConfigResponse" }, { "$ref": "#/components/schemas/GetShopifyAuthConfigResponse" }, { "$ref": "#/components/schemas/ListShopifyAuthConfigsResponse" }, { "$ref": "#/components/schemas/SaveShopifyAuthConfigResponse" } ] } } } } } } } }, "components": { "schemas": { "JsonRpcError": { "type": "object", "description": "JSON-RPC error object as emitted by the Moqui dispatcher", "properties": { "code": { "type": "integer", "enum": [ -32700, -32600, -32601, -32602, -32603, 500, 403 ], "description": "-32700 parse error; -32600 invalid request; -32601 method not found; -32602 invalid params; -32603 internal error (defined, rarely emitted); 500 service error (exception or unhandled ec.message errors); 403 authorization denied (ArtifactAuthorizationException)" }, "message": { "type": "string", "description": "Real error string from the backend" }, "data": { "description": "Optional implementation-specific detail" } }, "required": [ "code", "message" ] }, "JsonRpcErrorResponse": { "type": "object", "description": "Dispatcher-level failure: protocol errors (-32xxx), unhandled service errors (code 500), or authorization denial (code 403). Facade business validation does NOT use this shape \u2014 it returns a success envelope with result.ok=false and result.errors[].", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ] }, "error": { "$ref": "#/components/schemas/JsonRpcError" } }, "required": [ "jsonrpc", "error" ] }, "ChangeOwnPasswordParams": { "type": "object", "properties": { "currentPassword": { "type": "string", "description": "The authenticated user's current password." }, "newPassword": { "type": "string", "description": "The new password requested by the authenticated user." }, "newPasswordVerify": { "type": "string", "description": "Confirmation value for the new password." } }, "required": [ "currentPassword", "newPassword", "newPasswordVerify" ], "description": "Change the authenticated user's own password using Moqui's standard password policy checks." }, "ChangeOwnPasswordResult": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "True when the password update completed without facade errors." }, "messages": { "type": "array", "items": { "type": "string" }, "description": "Informational messages emitted during password update handling." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Errors returned while validating or changing the password." }, "authenticated": { "type": "boolean", "description": "True when the current request resolves to an authenticated session." }, "passwordUpdated": { "type": "boolean", "description": "True when Moqui successfully changed the authenticated user's password." }, "sessionInfo": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "locale": { "type": "string" }, "timeZone": { "type": "string" }, "lastLoginDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastRun": { "type": "object", "properties": { "reconciliationRunResultId": { "type": "string" }, "savedRunId": { "type": "string" }, "savedRunType": { "type": "string" }, "reconciliationRunId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } }, "scopeType": { "type": "string" }, "customerScopeId": { "type": "string" }, "activeTenantUserGroupId": { "type": "string" }, "activeTenantLabel": { "type": "string" }, "availableTenants": { "type": "array", "items": { "type": "object", "properties": { "userGroupId": { "type": "string" }, "label": { "type": "string" } } } }, "activeTenantPermissionGroupIds": { "type": "array", "items": { "type": "string" } }, "canViewActiveTenantData": { "type": "boolean" }, "canRunActiveTenantReconciliation": { "type": "boolean" }, "canEditActiveTenantData": { "type": "boolean" }, "canManageDarpanCore": { "type": "boolean" }, "isSuperAdmin": { "type": "boolean" } }, "description": "Refreshed authenticated session metadata returned to darpan-ui." } } }, "ChangeOwnPasswordRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.AuthFacadeServices.change#OwnPassword", "x-darpan-method": "facade.AuthFacadeServices.change#OwnPassword", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.AuthFacadeServices.change#OwnPassword" }, "params": { "$ref": "#/components/schemas/ChangeOwnPasswordParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ChangeOwnPasswordResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.AuthFacadeServices.change#OwnPassword. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ChangeOwnPasswordResult" } }, "required": [ "jsonrpc", "result" ] }, "GetSessionInfoParams": { "type": "object", "properties": { }, "description": "Return session metadata for darpan-ui route guards. Moqui resolves the request user from the explicit `login_key` header when present." }, "GetSessionInfoResult": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "True when the session info lookup completed without facade errors." }, "messages": { "type": "array", "items": { "type": "string" }, "description": "Informational messages emitted during session-info lookup." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Errors returned while resolving session state." }, "authenticated": { "type": "boolean", "description": "True when the current request resolves to an authenticated session." }, "sessionInfo": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "locale": { "type": "string" }, "timeZone": { "type": "string" }, "lastLoginDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastRun": { "type": "object", "properties": { "reconciliationRunResultId": { "type": "string" }, "savedRunId": { "type": "string" }, "savedRunType": { "type": "string" }, "reconciliationRunId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } }, "scopeType": { "type": "string" }, "customerScopeId": { "type": "string" }, "activeTenantUserGroupId": { "type": "string" }, "activeTenantLabel": { "type": "string" }, "availableTenants": { "type": "array", "items": { "type": "object", "properties": { "userGroupId": { "type": "string" }, "label": { "type": "string" } } } }, "activeTenantPermissionGroupIds": { "type": "array", "items": { "type": "string" } }, "canViewActiveTenantData": { "type": "boolean" }, "canRunActiveTenantReconciliation": { "type": "boolean" }, "canEditActiveTenantData": { "type": "boolean" }, "canManageDarpanCore": { "type": "boolean" }, "isSuperAdmin": { "type": "boolean" } }, "description": "Authenticated session metadata returned to darpan-ui." } } }, "GetSessionInfoRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.AuthFacadeServices.get#SessionInfo", "x-darpan-method": "facade.AuthFacadeServices.get#SessionInfo", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.AuthFacadeServices.get#SessionInfo" }, "params": { "$ref": "#/components/schemas/GetSessionInfoParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "GetSessionInfoResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.AuthFacadeServices.get#SessionInfo. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/GetSessionInfoResult" } }, "required": [ "jsonrpc", "result" ] }, "LoginSessionParams": { "type": "object", "properties": { "username": { "type": "string", "description": "Account username used for login." }, "password": { "type": "string", "description": "Account password used for login." } }, "required": [ "username", "password" ], "description": "Create an authenticated session from username/password and return the explicit Moqui login-key token darpan-ui sends on later requests." }, "LoginSessionResult": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "True when the login attempt completed without facade errors." }, "messages": { "type": "array", "items": { "type": "string" }, "description": "Informational messages emitted during login handling." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Validation or authentication errors for the login attempt." }, "authenticated": { "type": "boolean", "description": "True when the session is authenticated after the login attempt." }, "authToken": { "type": "string", "description": "Explicit login-key token that darpan-ui sends on later requests through the `login_key` header." }, "authTokenType": { "type": "string", "description": "Token scheme identifier. Current value: `LOGIN_KEY`." }, "authTokenHeaderName": { "type": "string", "description": "Request header name darpan-ui must send for stateless auth. Current value: `login_key`." }, "authTokenExpiresInSeconds": { "type": "integer", "description": "Approximate token lifetime in seconds, derived from the Moqui login-key expiry." }, "sessionInfo": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "locale": { "type": "string" }, "timeZone": { "type": "string" }, "lastLoginDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastRun": { "type": "object", "properties": { "reconciliationRunResultId": { "type": "string" }, "savedRunId": { "type": "string" }, "savedRunType": { "type": "string" }, "reconciliationRunId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } }, "scopeType": { "type": "string" }, "customerScopeId": { "type": "string" }, "activeTenantUserGroupId": { "type": "string" }, "activeTenantLabel": { "type": "string" }, "availableTenants": { "type": "array", "items": { "type": "object", "properties": { "userGroupId": { "type": "string" }, "label": { "type": "string" } } } }, "activeTenantPermissionGroupIds": { "type": "array", "items": { "type": "string" } }, "canViewActiveTenantData": { "type": "boolean" }, "canRunActiveTenantReconciliation": { "type": "boolean" }, "canEditActiveTenantData": { "type": "boolean" }, "canManageDarpanCore": { "type": "boolean" }, "isSuperAdmin": { "type": "boolean" } }, "description": "Authenticated session metadata returned to darpan-ui." } } }, "LoginSessionRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.AuthFacadeServices.login#Session", "x-darpan-method": "facade.AuthFacadeServices.login#Session", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.AuthFacadeServices.login#Session" }, "params": { "$ref": "#/components/schemas/LoginSessionParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "LoginSessionResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.AuthFacadeServices.login#Session. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/LoginSessionResult" } }, "required": [ "jsonrpc", "result" ] }, "LogoutAllSessionsParams": { "type": "object", "properties": { }, "description": "Revoke every active UserLoginKey for the authenticated user (sign out on every device)." }, "LogoutAllSessionsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "authenticated": { "type": "boolean" }, "authTokenRevoked": { "type": "boolean" }, "allSessionsRevoked": { "type": "integer", "description": "Count of UserLoginKey rows removed for the user." } } }, "LogoutAllSessionsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.AuthFacadeServices.logout#AllSessions", "x-darpan-method": "facade.AuthFacadeServices.logout#AllSessions", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.AuthFacadeServices.logout#AllSessions" }, "params": { "$ref": "#/components/schemas/LogoutAllSessionsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "LogoutAllSessionsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.AuthFacadeServices.logout#AllSessions. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/LogoutAllSessionsResult" } }, "required": [ "jsonrpc", "result" ] }, "LogoutSessionParams": { "type": "object", "properties": { }, "description": "Revoke the explicit login-key token from the current request and terminate any active authenticated session." }, "LogoutSessionResult": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "True when logout cleanup completed without facade errors." }, "messages": { "type": "array", "items": { "type": "string" }, "description": "Informational messages emitted during logout handling." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Errors returned while clearing session state." }, "authenticated": { "type": "boolean", "description": "Always false after logout cleanup finishes." }, "authTokenRevoked": { "type": "boolean", "description": "True when logout removed the matching `UserLoginKey` record for the supplied auth token." } } }, "LogoutSessionRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.AuthFacadeServices.logout#Session", "x-darpan-method": "facade.AuthFacadeServices.logout#Session", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.AuthFacadeServices.logout#Session" }, "params": { "$ref": "#/components/schemas/LogoutSessionParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "LogoutSessionResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.AuthFacadeServices.logout#Session. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/LogoutSessionResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveActiveTenantParams": { "type": "object", "properties": { "activeTenantUserGroupId": { "type": "string", "description": "User-group id for the tenant the user wants to work in." } }, "required": [ "activeTenantUserGroupId" ], "description": "Persist the authenticated user's active tenant selection and return refreshed session metadata." }, "SaveActiveTenantResult": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "True when the active-tenant update completed without facade errors." }, "messages": { "type": "array", "items": { "type": "string" }, "description": "Informational messages emitted during active-tenant handling." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Errors returned while validating or saving the active tenant." }, "authenticated": { "type": "boolean", "description": "True when the current request resolves to an authenticated session." }, "sessionInfo": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "locale": { "type": "string" }, "timeZone": { "type": "string" }, "lastLoginDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastRun": { "type": "object", "properties": { "reconciliationRunResultId": { "type": "string" }, "savedRunId": { "type": "string" }, "savedRunType": { "type": "string" }, "reconciliationRunId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } }, "scopeType": { "type": "string" }, "customerScopeId": { "type": "string" }, "activeTenantUserGroupId": { "type": "string" }, "activeTenantLabel": { "type": "string" }, "availableTenants": { "type": "array", "items": { "type": "object", "properties": { "userGroupId": { "type": "string" }, "label": { "type": "string" } } } }, "activeTenantPermissionGroupIds": { "type": "array", "items": { "type": "string" } }, "canViewActiveTenantData": { "type": "boolean" }, "canRunActiveTenantReconciliation": { "type": "boolean" }, "canEditActiveTenantData": { "type": "boolean" }, "canManageDarpanCore": { "type": "boolean" }, "isSuperAdmin": { "type": "boolean" } }, "description": "Refreshed authenticated session metadata returned to darpan-ui." } } }, "SaveActiveTenantRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.AuthFacadeServices.save#ActiveTenant", "x-darpan-method": "facade.AuthFacadeServices.save#ActiveTenant", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.AuthFacadeServices.save#ActiveTenant" }, "params": { "$ref": "#/components/schemas/SaveActiveTenantParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveActiveTenantResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.AuthFacadeServices.save#ActiveTenant. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveActiveTenantResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveUserSettingsParams": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Optional user display name shown by darpan-ui instead of username." } }, "description": "Persist authenticated user-level settings and return refreshed session metadata." }, "SaveUserSettingsResult": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "True when the user settings update completed without facade errors." }, "messages": { "type": "array", "items": { "type": "string" }, "description": "Informational messages emitted during user-settings handling." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Errors returned while validating or saving user settings." }, "authenticated": { "type": "boolean", "description": "True when the current request resolves to an authenticated session." }, "sessionInfo": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "locale": { "type": "string" }, "timeZone": { "type": "string" }, "lastLoginDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastRun": { "type": "object", "properties": { "reconciliationRunResultId": { "type": "string" }, "savedRunId": { "type": "string" }, "savedRunType": { "type": "string" }, "reconciliationRunId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } }, "scopeType": { "type": "string" }, "customerScopeId": { "type": "string" }, "activeTenantUserGroupId": { "type": "string" }, "activeTenantLabel": { "type": "string" }, "availableTenants": { "type": "array", "items": { "type": "object", "properties": { "userGroupId": { "type": "string" }, "label": { "type": "string" } } } }, "activeTenantPermissionGroupIds": { "type": "array", "items": { "type": "string" } }, "canViewActiveTenantData": { "type": "boolean" }, "canRunActiveTenantReconciliation": { "type": "boolean" }, "canEditActiveTenantData": { "type": "boolean" }, "canManageDarpanCore": { "type": "boolean" }, "isSuperAdmin": { "type": "boolean" } }, "description": "Refreshed authenticated session metadata returned to darpan-ui." } } }, "SaveUserSettingsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.AuthFacadeServices.save#UserSettings", "x-darpan-method": "facade.AuthFacadeServices.save#UserSettings", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.AuthFacadeServices.save#UserSettings" }, "params": { "$ref": "#/components/schemas/SaveUserSettingsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveUserSettingsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.AuthFacadeServices.save#UserSettings. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveUserSettingsResult" } }, "required": [ "jsonrpc", "result" ] }, "VerifyOwnPasswordParams": { "type": "object", "properties": { "currentPassword": { "type": "string", "description": "The authenticated user's current password to verify before a self-service password change proceeds." } }, "required": [ "currentPassword" ], "description": "Verify the authenticated user's current password without mutating the password or issuing a new login token." }, "VerifyOwnPasswordResult": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "True when the current-password verification completed without facade errors." }, "messages": { "type": "array", "items": { "type": "string" }, "description": "Informational messages emitted during password verification." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Errors returned while validating the current password." }, "authenticated": { "type": "boolean", "description": "True when the current request resolves to an authenticated session." }, "passwordVerified": { "type": "boolean", "description": "True when the provided password matches the authenticated user's current password." }, "sessionInfo": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "locale": { "type": "string" }, "timeZone": { "type": "string" }, "lastLoginDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastRun": { "type": "object", "properties": { "reconciliationRunResultId": { "type": "string" }, "savedRunId": { "type": "string" }, "savedRunType": { "type": "string" }, "reconciliationRunId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } }, "scopeType": { "type": "string" }, "customerScopeId": { "type": "string" }, "activeTenantUserGroupId": { "type": "string" }, "activeTenantLabel": { "type": "string" }, "availableTenants": { "type": "array", "items": { "type": "object", "properties": { "userGroupId": { "type": "string" }, "label": { "type": "string" } } } }, "activeTenantPermissionGroupIds": { "type": "array", "items": { "type": "string" } }, "canViewActiveTenantData": { "type": "boolean" }, "canRunActiveTenantReconciliation": { "type": "boolean" }, "canEditActiveTenantData": { "type": "boolean" }, "canManageDarpanCore": { "type": "boolean" }, "isSuperAdmin": { "type": "boolean" } }, "description": "Refreshed authenticated session metadata returned to darpan-ui." } } }, "VerifyOwnPasswordRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.AuthFacadeServices.verify#OwnPassword", "x-darpan-method": "facade.AuthFacadeServices.verify#OwnPassword", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.AuthFacadeServices.verify#OwnPassword" }, "params": { "$ref": "#/components/schemas/VerifyOwnPasswordParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "VerifyOwnPasswordResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.AuthFacadeServices.verify#OwnPassword. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/VerifyOwnPasswordResult" } }, "required": [ "jsonrpc", "result" ] }, "DeleteHotWaxOmsRestSourceConfigParams": { "type": "object", "properties": { "omsRestSourceConfigId": { "type": "string" } }, "required": [ "omsRestSourceConfigId" ], "description": "Delete one tenant-owned HotWax OMS REST source configuration." }, "DeleteHotWaxOmsRestSourceConfigResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { } }, "errors": { "type": "array", "items": { } }, "deleted": { "type": "boolean" }, "deletedOmsRestSourceConfigId": { "type": "string" } } }, "DeleteHotWaxOmsRestSourceConfigRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.HotWaxOmsFacadeServices.delete#HotWaxOmsRestSourceConfig", "x-darpan-method": "facade.HotWaxOmsFacadeServices.delete#HotWaxOmsRestSourceConfig", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.HotWaxOmsFacadeServices.delete#HotWaxOmsRestSourceConfig" }, "params": { "$ref": "#/components/schemas/DeleteHotWaxOmsRestSourceConfigParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "DeleteHotWaxOmsRestSourceConfigResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.HotWaxOmsFacadeServices.delete#HotWaxOmsRestSourceConfig. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/DeleteHotWaxOmsRestSourceConfigResult" } }, "required": [ "jsonrpc", "result" ] }, "ListHotWaxOmsRestSourceConfigsParams": { "type": "object", "properties": { "query": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List OMS REST source configurations available to the active tenant." }, "ListHotWaxOmsRestSourceConfigsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { } }, "errors": { "type": "array", "items": { } }, "omsRestSourceConfigs": { "type": "array", "items": { } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } } } }, "ListHotWaxOmsRestSourceConfigsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.HotWaxOmsFacadeServices.list#HotWaxOmsRestSourceConfigs", "x-darpan-method": "facade.HotWaxOmsFacadeServices.list#HotWaxOmsRestSourceConfigs", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.HotWaxOmsFacadeServices.list#HotWaxOmsRestSourceConfigs" }, "params": { "$ref": "#/components/schemas/ListHotWaxOmsRestSourceConfigsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListHotWaxOmsRestSourceConfigsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.HotWaxOmsFacadeServices.list#HotWaxOmsRestSourceConfigs. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListHotWaxOmsRestSourceConfigsResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveHotWaxOmsRestSourceConfigParams": { "type": "object", "properties": { "omsRestSourceConfigId": { "type": "string" }, "description": { "type": "string" }, "baseUrl": { "type": "string" }, "ordersPath": { "type": "string" }, "timeZone": { "type": "string" }, "authType": { "type": "string", "description": "Supported values are NONE, BASIC, BEARER, and API_KEY. API_KEY sends the encrypted API token in the OMS Swagger-documented api_key header." }, "username": { "type": "string" }, "password": { "type": "string" }, "apiToken": { "type": "string" }, "headersJson": { "type": "string" }, "connectTimeoutSeconds": { "type": "integer" }, "readTimeoutSeconds": { "type": "integer" }, "isActive": { "type": "boolean" }, "canReadOrders": { "type": "boolean" } }, "required": [ "omsRestSourceConfigId", "baseUrl" ], "description": "Create or update a tenant-owned OMS REST source configuration. Secret fields are stored encrypted and are never returned in clear text." }, "SaveHotWaxOmsRestSourceConfigResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { } }, "errors": { "type": "array", "items": { } }, "savedOmsRestSourceConfig": { "type": "object" } } }, "SaveHotWaxOmsRestSourceConfigRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.HotWaxOmsFacadeServices.save#HotWaxOmsRestSourceConfig", "x-darpan-method": "facade.HotWaxOmsFacadeServices.save#HotWaxOmsRestSourceConfig", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.HotWaxOmsFacadeServices.save#HotWaxOmsRestSourceConfig" }, "params": { "$ref": "#/components/schemas/SaveHotWaxOmsRestSourceConfigParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveHotWaxOmsRestSourceConfigResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.HotWaxOmsFacadeServices.save#HotWaxOmsRestSourceConfig. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveHotWaxOmsRestSourceConfigResult" } }, "required": [ "jsonrpc", "result" ] }, "DeleteJsonSchemaParams": { "type": "object", "properties": { "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" } }, "description": "Delete a saved JSON schema by id or schemaName." }, "DeleteJsonSchemaResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "deleted": { "type": "boolean" } } }, "DeleteJsonSchemaRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.JsonSchemaFacadeServices.delete#JsonSchema", "x-darpan-method": "facade.JsonSchemaFacadeServices.delete#JsonSchema", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.JsonSchemaFacadeServices.delete#JsonSchema" }, "params": { "$ref": "#/components/schemas/DeleteJsonSchemaParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "DeleteJsonSchemaResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.JsonSchemaFacadeServices.delete#JsonSchema. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/DeleteJsonSchemaResult" } }, "required": [ "jsonrpc", "result" ] }, "FlattenJsonSchemaParams": { "type": "object", "properties": { "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" } }, "description": "Flatten a saved schema to editor field rows." }, "FlattenJsonSchemaResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "jsonSchemaString": { "type": "string" }, "fieldList": { "type": "array", "items": { "type": "string" } } } }, "FlattenJsonSchemaRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.JsonSchemaFacadeServices.flatten#JsonSchema", "x-darpan-method": "facade.JsonSchemaFacadeServices.flatten#JsonSchema", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.JsonSchemaFacadeServices.flatten#JsonSchema" }, "params": { "$ref": "#/components/schemas/FlattenJsonSchemaParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "FlattenJsonSchemaResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.JsonSchemaFacadeServices.flatten#JsonSchema. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/FlattenJsonSchemaResult" } }, "required": [ "jsonrpc", "result" ] }, "GetJsonSchemaParams": { "type": "object", "properties": { "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" } }, "description": "Get a single JSON schema including schemaText." }, "GetJsonSchemaResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "schemaData": { "type": "object", "properties": { "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" }, "description": { "type": "string" }, "systemEnumId": { "type": "string" }, "systemLabel": { "type": "string" }, "ownerUserId": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "createdByUserId": { "type": "string" }, "schemaText": { "type": "string" }, "statusId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastUpdatedStamp": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } }, "GetJsonSchemaRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.JsonSchemaFacadeServices.get#JsonSchema", "x-darpan-method": "facade.JsonSchemaFacadeServices.get#JsonSchema", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.JsonSchemaFacadeServices.get#JsonSchema" }, "params": { "$ref": "#/components/schemas/GetJsonSchemaParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "GetJsonSchemaResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.JsonSchemaFacadeServices.get#JsonSchema. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/GetJsonSchemaResult" } }, "required": [ "jsonrpc", "result" ] }, "InferJsonSchemaFromTextParams": { "type": "object", "properties": { "jsonText": { "type": "string" } }, "required": [ "jsonText" ], "description": "Infer schema from JSON text and return flattened editor field rows." }, "InferJsonSchemaFromTextResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "jsonSchemaString": { "type": "string" }, "fieldList": { "type": "array", "items": { "type": "string" } } } }, "InferJsonSchemaFromTextRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.JsonSchemaFacadeServices.infer#JsonSchemaFromText", "x-darpan-method": "facade.JsonSchemaFacadeServices.infer#JsonSchemaFromText", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.JsonSchemaFacadeServices.infer#JsonSchemaFromText" }, "params": { "$ref": "#/components/schemas/InferJsonSchemaFromTextParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "InferJsonSchemaFromTextResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.JsonSchemaFacadeServices.infer#JsonSchemaFromText. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/InferJsonSchemaFromTextResult" } }, "required": [ "jsonrpc", "result" ] }, "ListJsonSchemasParams": { "type": "object", "properties": { "query": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List active JSON schemas with pagination for darpan-ui browse page." }, "ListJsonSchemasResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "schemas": { "type": "array", "items": { "type": "object", "properties": { "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" }, "description": { "type": "string" }, "systemEnumId": { "type": "string" }, "systemLabel": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "createdByUserId": { "type": "string" }, "statusId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastUpdatedStamp": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } } }, "ListJsonSchemasRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.JsonSchemaFacadeServices.list#JsonSchemas", "x-darpan-method": "facade.JsonSchemaFacadeServices.list#JsonSchemas", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.JsonSchemaFacadeServices.list#JsonSchemas" }, "params": { "$ref": "#/components/schemas/ListJsonSchemasParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListJsonSchemasResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.JsonSchemaFacadeServices.list#JsonSchemas. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListJsonSchemasResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveJsonSchemaTextParams": { "type": "object", "properties": { "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" }, "description": { "type": "string" }, "systemEnumId": { "type": "string" }, "schemaText": { "type": "string" }, "overwrite": { "type": "boolean" } }, "required": [ "schemaText" ], "description": "Save schema text directly from darpan-ui (no backend screen transition dependency)." }, "SaveJsonSchemaTextResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedSchema": { "type": "object", "properties": { "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" }, "description": { "type": "string" }, "systemEnumId": { "type": "string" }, "systemLabel": { "type": "string" }, "ownerUserId": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "createdByUserId": { "type": "string" }, "statusId": { "type": "string" }, "lastUpdatedStamp": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } }, "SaveJsonSchemaTextRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.JsonSchemaFacadeServices.save#JsonSchemaText", "x-darpan-method": "facade.JsonSchemaFacadeServices.save#JsonSchemaText", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.JsonSchemaFacadeServices.save#JsonSchemaText" }, "params": { "$ref": "#/components/schemas/SaveJsonSchemaTextParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveJsonSchemaTextResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.JsonSchemaFacadeServices.save#JsonSchemaText. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveJsonSchemaTextResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveRefinedSchemaParams": { "type": "object", "properties": { "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" }, "description": { "type": "string" }, "systemEnumId": { "type": "string" }, "fieldList": { "type": "array", "items": { } } }, "required": [ "fieldList" ], "description": "Save refined schema field rows from editor in darpan-ui." }, "SaveRefinedSchemaResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedSchema": { "type": "object", "properties": { "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" }, "filename": { "type": "string" }, "systemEnumId": { "type": "string" }, "systemLabel": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "createdByUserId": { "type": "string" }, "lastUpdatedStamp": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } }, "SaveRefinedSchemaRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.JsonSchemaFacadeServices.save#RefinedSchema", "x-darpan-method": "facade.JsonSchemaFacadeServices.save#RefinedSchema", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.JsonSchemaFacadeServices.save#RefinedSchema" }, "params": { "$ref": "#/components/schemas/SaveRefinedSchemaParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveRefinedSchemaResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.JsonSchemaFacadeServices.save#RefinedSchema. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveRefinedSchemaResult" } }, "required": [ "jsonrpc", "result" ] }, "ValidateJsonTextAgainstSchemaParams": { "type": "object", "properties": { "jsonText": { "type": "string" }, "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" } }, "required": [ "jsonText" ], "description": "Validate JSON text against a saved schema." }, "ValidateJsonTextAgainstSchemaResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "valid": { "type": "boolean" }, "errorCount": { "type": "integer" }, "errorMessages": { "type": "array", "items": { "type": "string" } } } }, "ValidateJsonTextAgainstSchemaRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.JsonSchemaFacadeServices.validate#JsonTextAgainstSchema", "x-darpan-method": "facade.JsonSchemaFacadeServices.validate#JsonTextAgainstSchema", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.JsonSchemaFacadeServices.validate#JsonTextAgainstSchema" }, "params": { "$ref": "#/components/schemas/ValidateJsonTextAgainstSchemaParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ValidateJsonTextAgainstSchemaResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.JsonSchemaFacadeServices.validate#JsonTextAgainstSchema. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ValidateJsonTextAgainstSchemaResult" } }, "required": [ "jsonrpc", "result" ] }, "CreateCsvRunParams": { "type": "object", "properties": { "runName": { "type": "string" }, "description": { "type": "string" }, "file1SystemEnumId": { "type": "string" }, "file2SystemEnumId": { "type": "string" }, "file1CompareColumn": { "type": "string" }, "file2CompareColumn": { "type": "string" } }, "required": [ "runName", "file1SystemEnumId", "file2SystemEnumId", "file1CompareColumn", "file2CompareColumn" ], "description": "Create a tenant-scoped CSV saved run backed by one RuleSet compare scope." }, "CreateCsvRunResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedRun": { "type": "object", "properties": { "savedRunId": { "type": "string" }, "runName": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "runType": { "type": "string" }, "ruleSetId": { "type": "string" }, "compareScopeId": { "type": "string" }, "requiresSystemSelection": { "type": "boolean" }, "defaultFile1SystemEnumId": { "type": "string" }, "defaultFile2SystemEnumId": { "type": "string" }, "systemOptions": { "type": "array", "items": { "type": "object", "properties": { "fileSide": { "type": "string" }, "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "fileTypeEnumId": { "type": "string" }, "fileTypeLabel": { "type": "string" }, "idFieldExpression": { "type": "string" }, "schemaFileName": { "type": "string" }, "sourceTypeEnumId": { "type": "string" }, "sourceTypeLabel": { "type": "string" }, "systemMessageRemoteId": { "type": "string" }, "systemMessageRemoteLabel": { "type": "string" }, "nsRestletConfigId": { "type": "string" }, "nsRestletConfigLabel": { "type": "string" }, "sourceConfigId": { "type": "string" }, "sourceConfigType": { "type": "string" } } } } } } } }, "CreateCsvRunRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.create#CsvRun", "x-darpan-method": "facade.ReconciliationFacadeServices.create#CsvRun", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.create#CsvRun" }, "params": { "$ref": "#/components/schemas/CreateCsvRunParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "CreateCsvRunResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.create#CsvRun. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/CreateCsvRunResult" } }, "required": [ "jsonrpc", "result" ] }, "CreateMappingParams": { "type": "object", "properties": { "mappingName": { "type": "string" }, "schema1Id": { "type": "string" }, "schema2Id": { "type": "string" }, "schema1FieldPath": { "type": "string" }, "schema2FieldPath": { "type": "string" } }, "required": [ "mappingName", "schema1Id", "schema2Id", "schema1FieldPath", "schema2FieldPath" ], "description": "Create a reconciliation mapping from two saved JSON schemas and selected id field paths." }, "CreateMappingResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedMapping": { "type": "object", "properties": { "reconciliationMappingId": { "type": "string" }, "mappingName": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "createdByUserId": { "type": "string" }, "file1SystemEnumId": { "type": "string" }, "file2SystemEnumId": { "type": "string" }, "file1SchemaName": { "type": "string" }, "file2SchemaName": { "type": "string" }, "file1FieldPath": { "type": "string" }, "file2FieldPath": { "type": "string" } } } } }, "CreateMappingRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.create#Mapping", "x-darpan-method": "facade.ReconciliationFacadeServices.create#Mapping", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.create#Mapping" }, "params": { "$ref": "#/components/schemas/CreateMappingParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "CreateMappingResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.create#Mapping. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/CreateMappingResult" } }, "required": [ "jsonrpc", "result" ] }, "CreateRuleSetRunParams": { "type": "object", "properties": { "runName": { "type": "string" }, "description": { "type": "string" }, "file1SystemEnumId": { "type": "string" }, "file1SourceTypeEnumId": { "type": "string" }, "file1SystemMessageRemoteId": { "type": "string" }, "file1NsRestletConfigId": { "type": "string" }, "file1SourceConfigId": { "type": "string" }, "file1SourceConfigType": { "type": "string" }, "file1FileTypeEnumId": { "type": "string" }, "file1SchemaFileName": { "type": "string" }, "file1RecordRootExpression": { "type": "string" }, "file1PrimaryIdExpression": { "type": "string" }, "file2SystemEnumId": { "type": "string" }, "file2SourceTypeEnumId": { "type": "string" }, "file2SystemMessageRemoteId": { "type": "string" }, "file2NsRestletConfigId": { "type": "string" }, "file2SourceConfigId": { "type": "string" }, "file2SourceConfigType": { "type": "string" }, "file2FileTypeEnumId": { "type": "string" }, "file2SchemaFileName": { "type": "string" }, "file2RecordRootExpression": { "type": "string" }, "file2PrimaryIdExpression": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "ruleId": { "type": "string" }, "sequenceNum": { "type": "integer" }, "ruleText": { "type": "string" }, "ruleLogic": { "type": "string" }, "ruleType": { "type": "string" }, "expression": { "type": "string" }, "enabled": { "type": "string" }, "severity": { "type": "string" } } } } }, "required": [ "runName", "file1SystemEnumId", "file2SystemEnumId" ], "description": "Create a tenant-scoped saved run backed by one RuleSet compare scope and zero or more initial rules." }, "CreateRuleSetRunResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedRun": { "type": "object", "properties": { "savedRunId": { "type": "string" }, "runName": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "runType": { "type": "string" }, "ruleSetId": { "type": "string" }, "compareScopeId": { "type": "string" }, "requiresSystemSelection": { "type": "boolean" }, "defaultFile1SystemEnumId": { "type": "string" }, "defaultFile2SystemEnumId": { "type": "string" }, "systemOptions": { "type": "array", "items": { "type": "object", "properties": { "fileSide": { "type": "string" }, "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "fileTypeEnumId": { "type": "string" }, "fileTypeLabel": { "type": "string" }, "idFieldExpression": { "type": "string" }, "schemaFileName": { "type": "string" }, "sourceTypeEnumId": { "type": "string" }, "sourceTypeLabel": { "type": "string" }, "systemMessageRemoteId": { "type": "string" }, "systemMessageRemoteLabel": { "type": "string" }, "nsRestletConfigId": { "type": "string" }, "nsRestletConfigLabel": { "type": "string" }, "sourceConfigId": { "type": "string" }, "sourceConfigType": { "type": "string" } } } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "ruleId": { "type": "string" }, "sequenceNum": { "type": "integer" }, "ruleText": { "type": "string" }, "ruleLogic": { "type": "string" }, "ruleType": { "type": "string" }, "expression": { "type": "string" }, "enabled": { "type": "string" }, "severity": { "type": "string" }, "file1FieldPath": { "type": "string" }, "file2FieldPath": { "type": "string" }, "operator": { "type": "string" }, "preActions": { "type": "array", "items": { "type": "object", "properties": { "fieldSide": { "type": "string" }, "action": { "type": "string" } } } } } } } } } } }, "CreateRuleSetRunRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.create#RuleSetRun", "x-darpan-method": "facade.ReconciliationFacadeServices.create#RuleSetRun", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.create#RuleSetRun" }, "params": { "$ref": "#/components/schemas/CreateRuleSetRunParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "CreateRuleSetRunResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.create#RuleSetRun. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/CreateRuleSetRunResult" } }, "required": [ "jsonrpc", "result" ] }, "DeleteAutomationParams": { "type": "object", "properties": { "automationId": { "type": "string" } }, "required": [ "automationId" ], "description": "Delete one tenant-scoped automation configuration, its source rows, and its execution history rows." }, "DeleteAutomationResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "deleted": { "type": "boolean" }, "deletedAutomationId": { "type": "string" }, "deletedSourceCount": { "type": "integer" }, "deletedExecutionCount": { "type": "integer" } } }, "DeleteAutomationRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.delete#Automation", "x-darpan-method": "facade.ReconciliationFacadeServices.delete#Automation", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.delete#Automation" }, "params": { "$ref": "#/components/schemas/DeleteAutomationParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "DeleteAutomationResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.delete#Automation. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/DeleteAutomationResult" } }, "required": [ "jsonrpc", "result" ] }, "DeleteGeneratedOutputParams": { "type": "object", "properties": { "fileName": { "type": "string", "description": "Generated-output file name or safe data-manager relative path returned by list#GeneratedOutputs." } }, "required": [ "fileName" ], "description": "Delete one scoped generated reconciliation diff output file." }, "DeleteGeneratedOutputResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "deleted": { "type": "boolean" }, "deletedFileName": { "type": "string" }, "statusMessage": { "type": "string" } } }, "DeleteGeneratedOutputRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.delete#GeneratedOutput", "x-darpan-method": "facade.ReconciliationFacadeServices.delete#GeneratedOutput", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.delete#GeneratedOutput" }, "params": { "$ref": "#/components/schemas/DeleteGeneratedOutputParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "DeleteGeneratedOutputResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.delete#GeneratedOutput. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/DeleteGeneratedOutputResult" } }, "required": [ "jsonrpc", "result" ] }, "DeleteSavedRunParams": { "type": "object", "properties": { "savedRunId": { "type": "string" } }, "required": [ "savedRunId" ], "description": "Delete one tenant-scoped saved run and generated outputs created for it." }, "DeleteSavedRunResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "deleted": { "type": "boolean" }, "deletedSavedRunId": { "type": "string" }, "deletedRunType": { "type": "string" }, "deletedGeneratedOutputCount": { "type": "integer" }, "deletedRuleCount": { "type": "integer" }, "deletedCompareScopeCount": { "type": "integer" }, "deletedCompareSourceCount": { "type": "integer" }, "deletedMappingMemberCount": { "type": "integer" } } }, "DeleteSavedRunRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.delete#SavedRun", "x-darpan-method": "facade.ReconciliationFacadeServices.delete#SavedRun", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.delete#SavedRun" }, "params": { "$ref": "#/components/schemas/DeleteSavedRunParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "DeleteSavedRunResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.delete#SavedRun. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/DeleteSavedRunResult" } }, "required": [ "jsonrpc", "result" ] }, "GetAutomationParams": { "type": "object", "properties": { "automationId": { "type": "string" } }, "required": [ "automationId" ], "description": "Get one tenant-scoped automation with editable source rows and dashboard summary fields." }, "GetAutomationResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "automation": { "type": "object" } } }, "GetAutomationRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.get#Automation", "x-darpan-method": "facade.ReconciliationFacadeServices.get#Automation", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.get#Automation" }, "params": { "$ref": "#/components/schemas/GetAutomationParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "GetAutomationResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.get#Automation. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/GetAutomationResult" } }, "required": [ "jsonrpc", "result" ] }, "GetGeneratedOutputParams": { "type": "object", "properties": { "fileName": { "type": "string", "description": "Generated-output file name or safe data-manager relative path returned by list#GeneratedOutputs." }, "format": { "type": "string" } }, "required": [ "fileName" ], "description": "Retrieve a scoped generated diff output for direct download from darpan-ui." }, "GetGeneratedOutputResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "outputFile": { "type": "object", "properties": { "fileName": { "type": "string" }, "downloadFileName": { "type": "string" }, "sourceFormat": { "type": "string" }, "format": { "type": "string" }, "contentType": { "type": "string" }, "contentText": { "type": "string" }, "sourceDetails": { "type": "object", "properties": { "mode": { "type": "string" }, "dateRange": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } } }, "files": { "type": "array", "items": { "type": "object", "properties": { "side": { "type": "string" }, "label": { "type": "string" }, "fileName": { "type": "string" }, "filePath": { "type": "string" }, "downloadFileName": { "type": "string" }, "sourceFormat": { "type": "string" }, "canDownload": { "type": "boolean" } } } } } } } } } }, "GetGeneratedOutputRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.get#GeneratedOutput", "x-darpan-method": "facade.ReconciliationFacadeServices.get#GeneratedOutput", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.get#GeneratedOutput" }, "params": { "$ref": "#/components/schemas/GetGeneratedOutputParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "GetGeneratedOutputResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.get#GeneratedOutput. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/GetGeneratedOutputResult" } }, "required": [ "jsonrpc", "result" ] }, "GetGeneratedOutputDifferencesParams": { "type": "object", "properties": { "fileName": { "type": "string", "description": "Generated-output result file name or safe relative path returned by list#GeneratedOutputs." }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "buckets": { "type": "string", "description": "Comma-separated active diff buckets (file-1,file-2,rule). Empty means all." }, "ruleFilterKey": { "type": "string", "description": "Rule selector key ('all', 'base-diff', or a specific rule filter key)." }, "search": { "type": "string", "description": "Optional record-id substring filter (case-insensitive)." }, "includeFacets": { "type": "boolean", "description": "Skip bucket counts + rule options for pure page navigation." } }, "required": [ "fileName" ], "description": "Return a bounded page of a JSON diff document's differences (plus whole-document facets,\n effective summary, metadata, and a download descriptor WITHOUT the file body) so darpan-ui\n can render large reconciliation results without loading the entire file. Audit #21." }, "GetGeneratedOutputDifferencesResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object" }, "summary": { "type": "object" }, "bucketCounts": { "type": "object" }, "ruleOptions": { "type": "array", "items": { } }, "differences": { "type": "array", "items": { } }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "totalDifferences": { "type": "integer" }, "totalFiltered": { "type": "integer" }, "outputFile": { "type": "object" } } }, "GetGeneratedOutputDifferencesRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.get#GeneratedOutputDifferences", "x-darpan-method": "facade.ReconciliationFacadeServices.get#GeneratedOutputDifferences", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.get#GeneratedOutputDifferences" }, "params": { "$ref": "#/components/schemas/GetGeneratedOutputDifferencesParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "GetGeneratedOutputDifferencesResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.get#GeneratedOutputDifferences. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/GetGeneratedOutputDifferencesResult" } }, "required": [ "jsonrpc", "result" ] }, "GetMappingParams": { "type": "object", "properties": { "reconciliationMappingId": { "type": "string" } }, "required": [ "reconciliationMappingId" ], "description": "Load one mapping with editable schema and field details for darpan-ui settings workflows." }, "GetMappingResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "mapping": { "type": "object", "properties": { "reconciliationMappingId": { "type": "string" }, "mappingName": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "createdByUserId": { "type": "string" }, "members": { "type": "array", "items": { "type": "object", "properties": { "mappingMemberId": { "type": "string" }, "systemEnumId": { "type": "string" }, "systemLabel": { "type": "string" }, "jsonSchemaId": { "type": "string" }, "schemaName": { "type": "string" }, "fieldPath": { "type": "string" } } } } } } } }, "GetMappingRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.get#Mapping", "x-darpan-method": "facade.ReconciliationFacadeServices.get#Mapping", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.get#Mapping" }, "params": { "$ref": "#/components/schemas/GetMappingParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "GetMappingResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.get#Mapping. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/GetMappingResult" } }, "required": [ "jsonrpc", "result" ] }, "ListAutomationExecutionsParams": { "type": "object", "properties": { "automationId": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List execution history for the active tenant, optionally filtered to one automation." }, "ListAutomationExecutionsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "executions": { "type": "array", "items": { "type": "object", "properties": { "automationExecutionId": { "type": "string" }, "automationId": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "statusEnumId": { "type": "string" }, "statusLabel": { "type": "string" }, "scheduledDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "startedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "completedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "resultFileName": { "type": "string" }, "resultDataManagerPath": { "type": "string" }, "reconciliationRunResultId": { "type": "string" }, "file1RecordCount": { "type": "integer" }, "file2RecordCount": { "type": "integer" }, "differenceCount": { "type": "integer" }, "onlyInFile1Count": { "type": "integer" }, "onlyInFile2Count": { "type": "integer" }, "errorMessage": { "type": "string" } } } } } }, "ListAutomationExecutionsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.list#AutomationExecutions", "x-darpan-method": "facade.ReconciliationFacadeServices.list#AutomationExecutions", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.list#AutomationExecutions" }, "params": { "$ref": "#/components/schemas/ListAutomationExecutionsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListAutomationExecutionsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.list#AutomationExecutions. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListAutomationExecutionsResult" } }, "required": [ "jsonrpc", "result" ] }, "ListAutomationSourceOptionsParams": { "type": "object", "properties": { }, "description": "List active-tenant saved runs, SFTP servers, NetSuite endpoints, system remotes, and enum options needed by automation workflows." }, "ListAutomationSourceOptionsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "inputModes": { "type": "array", "items": { "type": "object", "properties": { "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "sequenceNum": { "type": "integer" }, "label": { "type": "string" } } } }, "sourceTypes": { "type": "array", "items": { "type": "object", "properties": { "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "sequenceNum": { "type": "integer" }, "label": { "type": "string" } } } }, "relativeWindows": { "type": "array", "items": { "type": "object", "properties": { "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "sequenceNum": { "type": "integer" }, "label": { "type": "string" } } } }, "fileTypes": { "type": "array", "items": { "type": "object", "properties": { "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "sequenceNum": { "type": "integer" }, "label": { "type": "string" } } } }, "systems": { "type": "array", "items": { "type": "object", "properties": { "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "sequenceNum": { "type": "integer" }, "label": { "type": "string" } } } }, "savedRuns": { "type": "array", "items": { } }, "sftpServers": { "type": "array", "items": { } }, "sourceConfigs": { "type": "array", "items": { } }, "nsRestletConfigs": { "type": "array", "items": { } }, "systemRemotes": { "type": "array", "items": { } } } }, "ListAutomationSourceOptionsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.list#AutomationSourceOptions", "x-darpan-method": "facade.ReconciliationFacadeServices.list#AutomationSourceOptions", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.list#AutomationSourceOptions" }, "params": { "$ref": "#/components/schemas/ListAutomationSourceOptionsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListAutomationSourceOptionsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.list#AutomationSourceOptions. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListAutomationSourceOptionsResult" } }, "required": [ "jsonrpc", "result" ] }, "ListAutomationsParams": { "type": "object", "properties": { "query": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List tenant-scoped reconciliation automations with dashboard-ready saved-run, source, schedule, last-execution, and permission summaries." }, "ListAutomationsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "automations": { "type": "array", "items": { "type": "object", "properties": { "automationId": { "type": "string" }, "automationName": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "savedRunId": { "type": "string" }, "savedRunName": { "type": "string" }, "savedRunType": { "type": "string" }, "ruleSetId": { "type": "string" }, "compareScopeId": { "type": "string" }, "reconciliationMappingId": { "type": "string" }, "inputModeEnumId": { "type": "string" }, "inputModeLabel": { "type": "string" }, "inputModeCode": { "type": "string" }, "sourceSummary": { "type": "string" }, "scheduleExpr": { "type": "string" }, "scheduleSummary": { "type": "string" }, "timezone": { "type": "string" }, "nextScheduledFireTime": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastScheduledFireTime": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "relativeWindowTypeEnumId": { "type": "string" }, "relativeWindowLabel": { "type": "string" }, "relativeWindowCount": { "type": "integer" }, "customWindowStartDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "customWindowEndDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "maxWindowDays": { "type": "integer" }, "splitWindowDays": { "type": "integer" }, "isActive": { "type": "string" }, "active": { "type": "boolean" }, "executionCount": { "type": "integer" }, "lastExecution": { "type": "object" }, "permissions": { "type": "object" } } } } } }, "ListAutomationsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.list#Automations", "x-darpan-method": "facade.ReconciliationFacadeServices.list#Automations", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.list#Automations" }, "params": { "$ref": "#/components/schemas/ListAutomationsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListAutomationsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.list#Automations. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListAutomationsResult" } }, "required": [ "jsonrpc", "result" ] }, "ListGeneratedOutputsParams": { "type": "object", "properties": { "savedRunId": { "type": "string" }, "reconciliationMappingId": { "type": "string" }, "query": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List generated reconciliation diff outputs within the current active-tenant scope." }, "ListGeneratedOutputsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "generatedOutputs": { "type": "array", "items": { "type": "object", "properties": { "fileName": { "type": "string" }, "reconciliationRunResultId": { "type": "string" }, "sourceFormat": { "type": "string" }, "availableFormats": { "type": "array", "items": { "type": "string" } }, "preferredDownloadFormat": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "savedRunId": { "type": "string" }, "savedRunName": { "type": "string" }, "savedRunType": { "type": "string" }, "reconciliationMappingId": { "type": "string" }, "mappingName": { "type": "string" }, "ruleSetId": { "type": "string" }, "compareScopeId": { "type": "string" }, "reconciliationType": { "type": "string" }, "file1Label": { "type": "string" }, "file2Label": { "type": "string" }, "totalDifferences": { "type": "integer" }, "onlyInFile1Count": { "type": "integer" }, "onlyInFile2Count": { "type": "integer" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "sizeBytes": { "type": "integer" }, "statusEnumId": { "type": "string" }, "statusLabel": { "type": "string" }, "resultAvailable": { "type": "boolean" }, "startedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "completedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastUpdatedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } } }, "ListGeneratedOutputsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.list#GeneratedOutputs", "x-darpan-method": "facade.ReconciliationFacadeServices.list#GeneratedOutputs", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.list#GeneratedOutputs" }, "params": { "$ref": "#/components/schemas/ListGeneratedOutputsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListGeneratedOutputsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.list#GeneratedOutputs. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListGeneratedOutputsResult" } }, "required": [ "jsonrpc", "result" ] }, "ListMappingsParams": { "type": "object", "properties": { "query": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List mapping options and their system pairs for darpan-ui generic diff flow." }, "ListMappingsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "pinnedReconciliationMappingIds": { "type": "array", "items": { "type": "string" } }, "mappings": { "type": "array", "items": { "type": "object", "properties": { "reconciliationMappingId": { "type": "string" }, "mappingName": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "requiresSystemSelection": { "type": "boolean" }, "defaultFile1SystemEnumId": { "type": "string" }, "defaultFile2SystemEnumId": { "type": "string" }, "systemOptions": { "type": "array", "items": { "type": "object", "properties": { "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "fileTypeEnumId": { "type": "string" }, "fileTypeLabel": { "type": "string" }, "idFieldExpression": { "type": "string" }, "schemaFileName": { "type": "string" } } } } } } } } }, "ListMappingsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.list#Mappings", "x-darpan-method": "facade.ReconciliationFacadeServices.list#Mappings", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.list#Mappings" }, "params": { "$ref": "#/components/schemas/ListMappingsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListMappingsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.list#Mappings. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListMappingsResult" } }, "required": [ "jsonrpc", "result" ] }, "ListSavedRunsParams": { "type": "object", "properties": { "query": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List saved runs across legacy mappings and RuleSet-backed CSV runs." }, "ListSavedRunsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "pinnedSavedRunIds": { "type": "array", "items": { "type": "string" } }, "savedRuns": { "type": "array", "items": { "type": "object", "properties": { "savedRunId": { "type": "string" }, "runName": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "runType": { "type": "string" }, "reconciliationMappingId": { "type": "string" }, "ruleSetId": { "type": "string" }, "compareScopeId": { "type": "string" }, "requiresSystemSelection": { "type": "boolean" }, "defaultFile1SystemEnumId": { "type": "string" }, "defaultFile2SystemEnumId": { "type": "string" }, "systemOptions": { "type": "array", "items": { "type": "object", "properties": { "fileSide": { "type": "string" }, "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "fileTypeEnumId": { "type": "string" }, "fileTypeLabel": { "type": "string" }, "idFieldExpression": { "type": "string" }, "schemaFileName": { "type": "string" }, "sourceTypeEnumId": { "type": "string" }, "sourceTypeLabel": { "type": "string" }, "systemMessageRemoteId": { "type": "string" }, "systemMessageRemoteLabel": { "type": "string" }, "nsRestletConfigId": { "type": "string" }, "nsRestletConfigLabel": { "type": "string" }, "sourceConfigId": { "type": "string" }, "sourceConfigType": { "type": "string" } } } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "ruleId": { "type": "string" }, "sequenceNum": { "type": "integer" }, "ruleText": { "type": "string" }, "ruleLogic": { "type": "string" }, "ruleType": { "type": "string" }, "expression": { "type": "string" }, "enabled": { "type": "string" }, "severity": { "type": "string" }, "file1FieldPath": { "type": "string" }, "file2FieldPath": { "type": "string" }, "operator": { "type": "string" }, "preActions": { "type": "array", "items": { "type": "object", "properties": { "fieldSide": { "type": "string" }, "action": { "type": "string" } } } } } } } } } } } }, "ListSavedRunsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.list#SavedRuns", "x-darpan-method": "facade.ReconciliationFacadeServices.list#SavedRuns", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.list#SavedRuns" }, "params": { "$ref": "#/components/schemas/ListSavedRunsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListSavedRunsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.list#SavedRuns. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListSavedRunsResult" } }, "required": [ "jsonrpc", "result" ] }, "PauseAutomationParams": { "type": "object", "properties": { "automationId": { "type": "string" } }, "required": [ "automationId" ], "description": "Pause one tenant-scoped automation by setting isActive to N." }, "PauseAutomationResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "automation": { "type": "object" } } }, "PauseAutomationRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.pause#Automation", "x-darpan-method": "facade.ReconciliationFacadeServices.pause#Automation", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.pause#Automation" }, "params": { "$ref": "#/components/schemas/PauseAutomationParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "PauseAutomationResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.pause#Automation. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/PauseAutomationResult" } }, "required": [ "jsonrpc", "result" ] }, "ReprocessAutomationExecutionParams": { "type": "object", "properties": { "automationExecutionId": { "type": "string" }, "maxRetryCount": { "type": "integer", "description": "Optional override for the retry budget on the re-driven execution; defaults to the execution's existing/platform value." } }, "required": [ "automationExecutionId" ], "description": "Operator re-drive: reset a FAILED or dead-lettered automation execution to PENDING so the retry scanner runs it again, after active-tenant ownership and run-permission validation." }, "ReprocessAutomationExecutionResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "automationExecutionId": { "type": "string" }, "statusEnumId": { "type": "string" }, "requeued": { "type": "boolean" } } }, "ReprocessAutomationExecutionRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.reprocess#AutomationExecution", "x-darpan-method": "facade.ReconciliationFacadeServices.reprocess#AutomationExecution", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.reprocess#AutomationExecution" }, "params": { "$ref": "#/components/schemas/ReprocessAutomationExecutionParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ReprocessAutomationExecutionResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.reprocess#AutomationExecution. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ReprocessAutomationExecutionResult" } }, "required": [ "jsonrpc", "result" ] }, "ResumeAutomationParams": { "type": "object", "properties": { "automationId": { "type": "string" } }, "required": [ "automationId" ], "description": "Resume one tenant-scoped automation by setting isActive to Y." }, "ResumeAutomationResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "automation": { "type": "object" } } }, "ResumeAutomationRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.resume#Automation", "x-darpan-method": "facade.ReconciliationFacadeServices.resume#Automation", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.resume#Automation" }, "params": { "$ref": "#/components/schemas/ResumeAutomationParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ResumeAutomationResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.resume#Automation. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ResumeAutomationResult" } }, "required": [ "jsonrpc", "result" ] }, "RunAutomationNowParams": { "type": "object", "properties": { "automationId": { "type": "string" }, "scheduledFireTime": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "windowStartDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "windowEndDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "hasHeader": { "type": "boolean" }, "outputLocation": { "type": "string" }, "sparkMaster": { "type": "string" }, "sparkAppName": { "type": "string" } }, "required": [ "automationId" ], "description": "Run one automation immediately after active-tenant ownership and run-permission validation." }, "RunAutomationNowResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "automation": { "type": "object" }, "runResult": { "type": "object" } } }, "RunAutomationNowRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.run#AutomationNow", "x-darpan-method": "facade.ReconciliationFacadeServices.run#AutomationNow", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.run#AutomationNow" }, "params": { "$ref": "#/components/schemas/RunAutomationNowParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "RunAutomationNowResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.run#AutomationNow. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/RunAutomationNowResult" } }, "required": [ "jsonrpc", "result" ] }, "RunGenericDiffParams": { "type": "object", "properties": { "reconciliationMappingId": { "type": "string" }, "file1Name": { "type": "string" }, "file1Text": { "type": "string" }, "file2Name": { "type": "string" }, "file2Text": { "type": "string" }, "file1SystemEnumId": { "type": "string" }, "file2SystemEnumId": { "type": "string" }, "hasHeader": { "type": "boolean" }, "sparkMaster": { "type": "string" }, "sparkAppName": { "type": "string" } }, "required": [ "reconciliationMappingId" ], "description": "Run the generic diff flow using text-based file payloads suitable for darpan-ui JSON-RPC calls." }, "RunGenericDiffResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "runResult": { "type": "object", "properties": { "reconciliationMappingId": { "type": "string" }, "mappingName": { "type": "string" }, "reconciliationRunResultId": { "type": "string" }, "file1Name": { "type": "string" }, "file2Name": { "type": "string" }, "file1SystemEnumId": { "type": "string" }, "file1SystemLabel": { "type": "string" }, "file2SystemEnumId": { "type": "string" }, "file2SystemLabel": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "string" } }, "processingWarnings": { "type": "array", "items": { "type": "string" } }, "generatedOutput": { "type": "object", "properties": { "fileName": { "type": "string" }, "reconciliationRunResultId": { "type": "string" }, "sourceFormat": { "type": "string" }, "availableFormats": { "type": "array", "items": { "type": "string" } }, "preferredDownloadFormat": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "reconciliationMappingId": { "type": "string" }, "mappingName": { "type": "string" }, "reconciliationType": { "type": "string" }, "file1Label": { "type": "string" }, "file2Label": { "type": "string" }, "totalDifferences": { "type": "integer" }, "onlyInFile1Count": { "type": "integer" }, "onlyInFile2Count": { "type": "integer" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "sizeBytes": { "type": "integer" }, "statusEnumId": { "type": "string" }, "statusLabel": { "type": "string" }, "resultAvailable": { "type": "boolean" }, "startedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "completedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastUpdatedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } } } }, "RunGenericDiffRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.run#GenericDiff", "x-darpan-method": "facade.ReconciliationFacadeServices.run#GenericDiff", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.run#GenericDiff" }, "params": { "$ref": "#/components/schemas/RunGenericDiffParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "RunGenericDiffResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.run#GenericDiff. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/RunGenericDiffResult" } }, "required": [ "jsonrpc", "result" ] }, "RunSavedRunDiffParams": { "type": "object", "properties": { "savedRunId": { "type": "string" }, "file1Name": { "type": "string" }, "file1Text": { "type": "string" }, "file2Name": { "type": "string" }, "file2Text": { "type": "string" }, "file1SystemEnumId": { "type": "string" }, "file2SystemEnumId": { "type": "string" }, "windowStartDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "windowEndDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "windowStartLocalDate": { "type": "string" }, "windowEndLocalDate": { "type": "string" }, "hasHeader": { "type": "boolean" }, "sparkMaster": { "type": "string" }, "sparkAppName": { "type": "string" } }, "required": [ "savedRunId" ], "description": "Run a saved reconciliation flow backed by either a legacy mapping or a RuleSet compare scope." }, "RunSavedRunDiffResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "runResult": { "type": "object", "properties": { "savedRunId": { "type": "string" }, "runName": { "type": "string" }, "runType": { "type": "string" }, "reconciliationMappingId": { "type": "string" }, "reconciliationRunResultId": { "type": "string" }, "ruleSetId": { "type": "string" }, "compareScopeId": { "type": "string" }, "file1Name": { "type": "string" }, "file2Name": { "type": "string" }, "file1SystemEnumId": { "type": "string" }, "file1SystemLabel": { "type": "string" }, "file2SystemEnumId": { "type": "string" }, "file2SystemLabel": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "string" } }, "processingWarnings": { "type": "array", "items": { "type": "string" } }, "generatedOutput": { "type": "object", "properties": { "fileName": { "type": "string" }, "reconciliationRunResultId": { "type": "string" }, "sourceFormat": { "type": "string" }, "availableFormats": { "type": "array", "items": { "type": "string" } }, "preferredDownloadFormat": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "savedRunId": { "type": "string" }, "savedRunName": { "type": "string" }, "savedRunType": { "type": "string" }, "reconciliationMappingId": { "type": "string" }, "mappingName": { "type": "string" }, "ruleSetId": { "type": "string" }, "compareScopeId": { "type": "string" }, "reconciliationType": { "type": "string" }, "file1Label": { "type": "string" }, "file2Label": { "type": "string" }, "totalDifferences": { "type": "integer" }, "onlyInFile1Count": { "type": "integer" }, "onlyInFile2Count": { "type": "integer" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "sizeBytes": { "type": "integer" }, "statusEnumId": { "type": "string" }, "statusLabel": { "type": "string" }, "resultAvailable": { "type": "boolean" }, "startedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "completedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastUpdatedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } } } }, "RunSavedRunDiffRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.run#SavedRunDiff", "x-darpan-method": "facade.ReconciliationFacadeServices.run#SavedRunDiff", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.run#SavedRunDiff" }, "params": { "$ref": "#/components/schemas/RunSavedRunDiffParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "RunSavedRunDiffResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.run#SavedRunDiff. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/RunSavedRunDiffResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveAutomationParams": { "type": "object", "properties": { "automationId": { "type": "string" }, "automationName": { "type": "string" }, "description": { "type": "string" }, "inputModeEnumId": { "type": "string" }, "savedRunId": { "type": "string" }, "savedRunType": { "type": "string" }, "savedRun": { "type": "object" }, "newSavedRun": { "type": "object" }, "scheduleExpr": { "type": "string" }, "nextScheduledFireTime": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastScheduledFireTime": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "relativeWindowTypeEnumId": { "type": "string" }, "relativeWindowCount": { "type": "integer" }, "customWindowStartDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "customWindowEndDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "maxWindowDays": { "type": "integer" }, "splitWindowDays": { "type": "integer" }, "windowTimeZone": { "type": "string" }, "safeConfigJson": { "type": "string" }, "isActive": { "type": "boolean" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "fileSide": { "type": "string" }, "sourceTypeEnumId": { "type": "string" }, "systemEnumId": { "type": "string" }, "fileTypeEnumId": { "type": "string" }, "schemaFileName": { "type": "string" }, "recordRootExpression": { "type": "string" }, "primaryIdExpression": { "type": "string" }, "idValueNormalizer": { "type": "string" }, "systemMessageRemoteId": { "type": "string" }, "nsRestletConfigId": { "type": "string" }, "sftpServerId": { "type": "string" }, "remotePathTemplate": { "type": "string" }, "fileNamePattern": { "type": "string" }, "apiRequestTemplateJson": { "type": "string" }, "apiResponsePathExpression": { "type": "string" }, "dateFromParameterName": { "type": "string" }, "dateToParameterName": { "type": "string" }, "safeMetadataJson": { "type": "string" }, "optionKey": { "type": "string" }, "sourceConfigId": { "type": "string" }, "shopifyAuthConfigId": { "type": "string" }, "omsRestSourceConfigId": { "type": "string" } } } } }, "required": [ "automationName", "inputModeEnumId" ], "description": "Create or update a tenant-scoped automation against either an existing saved run or a newly-created saved run payload." }, "SaveAutomationResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "automation": { "type": "object" } } }, "SaveAutomationRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.save#Automation", "x-darpan-method": "facade.ReconciliationFacadeServices.save#Automation", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.save#Automation" }, "params": { "$ref": "#/components/schemas/SaveAutomationParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveAutomationResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.save#Automation. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveAutomationResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveDashboardPinnedMappingsParams": { "type": "object", "properties": { "pinnedReconciliationMappingIds": { "type": "array", "items": { "type": "string" } } }, "description": "Persist dashboard pinned reconciliation mappings for the authenticated user." }, "SaveDashboardPinnedMappingsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pinnedReconciliationMappingIds": { "type": "array", "items": { "type": "string" } } } }, "SaveDashboardPinnedMappingsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.save#DashboardPinnedMappings", "x-darpan-method": "facade.ReconciliationFacadeServices.save#DashboardPinnedMappings", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.save#DashboardPinnedMappings" }, "params": { "$ref": "#/components/schemas/SaveDashboardPinnedMappingsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveDashboardPinnedMappingsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.save#DashboardPinnedMappings. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveDashboardPinnedMappingsResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveDashboardPinnedSavedRunsParams": { "type": "object", "properties": { "pinnedSavedRunIds": { "type": "array", "items": { "type": "string" } } }, "description": "Persist dashboard pinned saved runs for the authenticated user." }, "SaveDashboardPinnedSavedRunsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pinnedSavedRunIds": { "type": "array", "items": { "type": "string" } } } }, "SaveDashboardPinnedSavedRunsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.save#DashboardPinnedSavedRuns", "x-darpan-method": "facade.ReconciliationFacadeServices.save#DashboardPinnedSavedRuns", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.save#DashboardPinnedSavedRuns" }, "params": { "$ref": "#/components/schemas/SaveDashboardPinnedSavedRunsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveDashboardPinnedSavedRunsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.save#DashboardPinnedSavedRuns. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveDashboardPinnedSavedRunsResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveMappingParams": { "type": "object", "properties": { "reconciliationMappingId": { "type": "string" }, "mappingName": { "type": "string" }, "schema1Id": { "type": "string" }, "schema2Id": { "type": "string" }, "schema1FieldPath": { "type": "string" }, "schema2FieldPath": { "type": "string" } }, "required": [ "reconciliationMappingId", "mappingName", "schema1Id", "schema2Id", "schema1FieldPath", "schema2FieldPath" ], "description": "Update an existing two-source mapping for darpan-ui settings workflows." }, "SaveMappingResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedMapping": { "type": "object", "properties": { "reconciliationMappingId": { "type": "string" }, "mappingName": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "createdByUserId": { "type": "string" }, "file1SystemEnumId": { "type": "string" }, "file2SystemEnumId": { "type": "string" }, "file1SchemaName": { "type": "string" }, "file2SchemaName": { "type": "string" }, "file1FieldPath": { "type": "string" }, "file2FieldPath": { "type": "string" } } } } }, "SaveMappingRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.save#Mapping", "x-darpan-method": "facade.ReconciliationFacadeServices.save#Mapping", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.save#Mapping" }, "params": { "$ref": "#/components/schemas/SaveMappingParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveMappingResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.save#Mapping. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveMappingResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveRuleSetRunParams": { "type": "object", "properties": { "savedRunId": { "type": "string" }, "runName": { "type": "string" }, "description": { "type": "string" }, "file1SystemEnumId": { "type": "string" }, "file1SourceTypeEnumId": { "type": "string" }, "file1SystemMessageRemoteId": { "type": "string" }, "file1NsRestletConfigId": { "type": "string" }, "file1SourceConfigId": { "type": "string" }, "file1SourceConfigType": { "type": "string" }, "file1FileTypeEnumId": { "type": "string" }, "file1SchemaFileName": { "type": "string" }, "file1RecordRootExpression": { "type": "string" }, "file1PrimaryIdExpression": { "type": "string" }, "file2SystemEnumId": { "type": "string" }, "file2SourceTypeEnumId": { "type": "string" }, "file2SystemMessageRemoteId": { "type": "string" }, "file2NsRestletConfigId": { "type": "string" }, "file2SourceConfigId": { "type": "string" }, "file2SourceConfigType": { "type": "string" }, "file2FileTypeEnumId": { "type": "string" }, "file2SchemaFileName": { "type": "string" }, "file2RecordRootExpression": { "type": "string" }, "file2PrimaryIdExpression": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "ruleId": { "type": "string" }, "sequenceNum": { "type": "integer" }, "ruleText": { "type": "string" }, "ruleLogic": { "type": "string" }, "ruleType": { "type": "string" }, "expression": { "type": "string" }, "enabled": { "type": "string" }, "severity": { "type": "string" } } } } }, "required": [ "savedRunId", "runName", "file1SystemEnumId", "file2SystemEnumId" ], "description": "Update configuration and, when provided, the executable rules for a tenant-scoped RuleSet-backed saved run." }, "SaveRuleSetRunResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedRun": { "type": "object", "properties": { "savedRunId": { "type": "string" }, "runName": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "runType": { "type": "string" }, "ruleSetId": { "type": "string" }, "compareScopeId": { "type": "string" }, "requiresSystemSelection": { "type": "boolean" }, "defaultFile1SystemEnumId": { "type": "string" }, "defaultFile2SystemEnumId": { "type": "string" }, "systemOptions": { "type": "array", "items": { "type": "object", "properties": { "fileSide": { "type": "string" }, "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "fileTypeEnumId": { "type": "string" }, "fileTypeLabel": { "type": "string" }, "idFieldExpression": { "type": "string" }, "schemaFileName": { "type": "string" }, "sourceTypeEnumId": { "type": "string" }, "sourceTypeLabel": { "type": "string" }, "systemMessageRemoteId": { "type": "string" }, "systemMessageRemoteLabel": { "type": "string" }, "nsRestletConfigId": { "type": "string" }, "nsRestletConfigLabel": { "type": "string" }, "sourceConfigId": { "type": "string" }, "sourceConfigType": { "type": "string" } } } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "ruleId": { "type": "string" }, "sequenceNum": { "type": "integer" }, "ruleText": { "type": "string" }, "ruleLogic": { "type": "string" }, "ruleType": { "type": "string" }, "expression": { "type": "string" }, "enabled": { "type": "string" }, "severity": { "type": "string" }, "file1FieldPath": { "type": "string" }, "file2FieldPath": { "type": "string" }, "operator": { "type": "string" }, "preActions": { "type": "array", "items": { "type": "object", "properties": { "fieldSide": { "type": "string" }, "action": { "type": "string" } } } } } } } } } } }, "SaveRuleSetRunRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.save#RuleSetRun", "x-darpan-method": "facade.ReconciliationFacadeServices.save#RuleSetRun", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.save#RuleSetRun" }, "params": { "$ref": "#/components/schemas/SaveRuleSetRunParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveRuleSetRunResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.save#RuleSetRun. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveRuleSetRunResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveSavedRunNameParams": { "type": "object", "properties": { "savedRunId": { "type": "string" }, "runName": { "type": "string" } }, "required": [ "savedRunId", "runName" ], "description": "Rename one tenant-scoped saved run without changing its source or rule configuration." }, "SaveSavedRunNameResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedRun": { "type": "object", "properties": { "savedRunId": { "type": "string" }, "runName": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "runType": { "type": "string" }, "reconciliationMappingId": { "type": "string" }, "ruleSetId": { "type": "string" }, "compareScopeId": { "type": "string" }, "requiresSystemSelection": { "type": "boolean" }, "defaultFile1SystemEnumId": { "type": "string" }, "defaultFile2SystemEnumId": { "type": "string" }, "systemOptions": { "type": "array", "items": { "type": "object", "properties": { "fileSide": { "type": "string" }, "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "fileTypeEnumId": { "type": "string" }, "fileTypeLabel": { "type": "string" }, "idFieldExpression": { "type": "string" }, "schemaFileName": { "type": "string" }, "sourceTypeEnumId": { "type": "string" }, "sourceTypeLabel": { "type": "string" }, "systemMessageRemoteId": { "type": "string" }, "systemMessageRemoteLabel": { "type": "string" }, "nsRestletConfigId": { "type": "string" }, "nsRestletConfigLabel": { "type": "string" }, "sourceConfigId": { "type": "string" }, "sourceConfigType": { "type": "string" } } } } } } } }, "SaveSavedRunNameRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ReconciliationFacadeServices.save#SavedRunName", "x-darpan-method": "facade.ReconciliationFacadeServices.save#SavedRunName", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ReconciliationFacadeServices.save#SavedRunName" }, "params": { "$ref": "#/components/schemas/SaveSavedRunNameParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveSavedRunNameResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ReconciliationFacadeServices.save#SavedRunName. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveSavedRunNameResult" } }, "required": [ "jsonrpc", "result" ] }, "SearchNavigationTargetsParams": { "type": "object", "properties": { "query": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "Search authorized Darpan records and return normalized navigation targets for Ask Darpan." }, "SearchNavigationTargetsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "results": { "type": "array", "items": { "type": "object", "properties": { "resultId": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "routeName": { "type": "string" }, "routePath": { "type": "string" }, "routeParams": { "type": "object" }, "routeQuery": { "type": "object" }, "score": { "type": "integer" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" } } } } } }, "SearchNavigationTargetsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SearchFacadeServices.search#NavigationTargets", "x-darpan-method": "facade.SearchFacadeServices.search#NavigationTargets", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SearchFacadeServices.search#NavigationTargets" }, "params": { "$ref": "#/components/schemas/SearchNavigationTargetsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SearchNavigationTargetsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SearchFacadeServices.search#NavigationTargets. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SearchNavigationTargetsResult" } }, "required": [ "jsonrpc", "result" ] }, "GetLlmSettingsParams": { "type": "object", "properties": { "llmProvider": { "type": "string" } }, "description": "Get LLM provider settings with stored-secret indicators." }, "GetLlmSettingsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "llmSettings": { "type": "object", "properties": { "activeProvider": { "type": "string" }, "llmProvider": { "type": "string" }, "llmModel": { "type": "string" }, "llmBaseUrl": { "type": "string" }, "llmTimeoutSeconds": { "type": "string" }, "llmEnabled": { "type": "string" }, "hasStoredLlmApiKey": { "type": "boolean" }, "hasFallbackLlmApiKey": { "type": "boolean" }, "fallbackLlmKeyEnvName": { "type": "string" } } } } }, "GetLlmSettingsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.get#LlmSettings", "x-darpan-method": "facade.SettingsFacadeServices.get#LlmSettings", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.get#LlmSettings" }, "params": { "$ref": "#/components/schemas/GetLlmSettingsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "GetLlmSettingsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.get#LlmSettings. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/GetLlmSettingsResult" } }, "required": [ "jsonrpc", "result" ] }, "GetTenantNotificationSettingsParams": { "type": "object", "properties": { }, "description": "Get active-tenant notification settings with Google Chat webhook redaction." }, "GetTenantNotificationSettingsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "tenantNotificationSettings": { "type": "object", "properties": { "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "googleChatConfigured": { "type": "boolean" }, "googleChatWebhookUrlMasked": { "type": "string" }, "isActive": { "type": "string" }, "createdByUserId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastUpdatedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } }, "GetTenantNotificationSettingsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.get#TenantNotificationSettings", "x-darpan-method": "facade.SettingsFacadeServices.get#TenantNotificationSettings", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.get#TenantNotificationSettings" }, "params": { "$ref": "#/components/schemas/GetTenantNotificationSettingsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "GetTenantNotificationSettingsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.get#TenantNotificationSettings. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/GetTenantNotificationSettingsResult" } }, "required": [ "jsonrpc", "result" ] }, "GetTenantSettingsParams": { "type": "object", "properties": { }, "description": "Get active-tenant settings shared by users in the tenant." }, "GetTenantSettingsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "tenantSettings": { "type": "object", "properties": { "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "timeZone": { "type": "string" }, "createdByUserId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastUpdatedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } }, "GetTenantSettingsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.get#TenantSettings", "x-darpan-method": "facade.SettingsFacadeServices.get#TenantSettings", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.get#TenantSettings" }, "params": { "$ref": "#/components/schemas/GetTenantSettingsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "GetTenantSettingsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.get#TenantSettings. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/GetTenantSettingsResult" } }, "required": [ "jsonrpc", "result" ] }, "ListEnumOptionsParams": { "type": "object", "properties": { "enumTypeId": { "type": "string" } }, "required": [ "enumTypeId" ], "description": "List enum options for frontend dropdowns using fallback-friendly labels." }, "ListEnumOptionsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "options": { "type": "array", "items": { "type": "object", "properties": { "enumId": { "type": "string" }, "enumCode": { "type": "string" }, "description": { "type": "string" }, "sequenceNum": { "type": "integer" }, "label": { "type": "string" } } } } } }, "ListEnumOptionsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.list#EnumOptions", "x-darpan-method": "facade.SettingsFacadeServices.list#EnumOptions", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.list#EnumOptions" }, "params": { "$ref": "#/components/schemas/ListEnumOptionsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListEnumOptionsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.list#EnumOptions. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListEnumOptionsResult" } }, "required": [ "jsonrpc", "result" ] }, "ListNsAuthConfigsParams": { "type": "object", "properties": { "query": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List NetSuite auth configurations with secret indicators." }, "ListNsAuthConfigsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "authConfigs": { "type": "array", "items": { "type": "object", "properties": { "nsAuthConfigId": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "authType": { "type": "string" }, "username": { "type": "string" }, "tokenUrl": { "type": "string" }, "clientId": { "type": "string" }, "certId": { "type": "string" }, "scope": { "type": "string" }, "isActive": { "type": "string" }, "hasPassword": { "type": "boolean" }, "hasApiToken": { "type": "boolean" }, "hasPrivateKeyPem": { "type": "boolean" } } } } } }, "ListNsAuthConfigsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.list#NsAuthConfigs", "x-darpan-method": "facade.SettingsFacadeServices.list#NsAuthConfigs", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.list#NsAuthConfigs" }, "params": { "$ref": "#/components/schemas/ListNsAuthConfigsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListNsAuthConfigsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.list#NsAuthConfigs. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListNsAuthConfigsResult" } }, "required": [ "jsonrpc", "result" ] }, "ListNsRestletConfigsParams": { "type": "object", "properties": { "query": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List NetSuite endpoint configs joined with auth metadata." }, "ListNsRestletConfigsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "restletConfigs": { "type": "array", "items": { "type": "object", "properties": { "nsRestletConfigId": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "endpointUrl": { "type": "string" }, "httpMethod": { "type": "string" }, "nsAuthConfigId": { "type": "string" }, "authDescription": { "type": "string" }, "authType": { "type": "string" }, "authIsActive": { "type": "string" }, "headersJson": { "type": "string" }, "connectTimeoutSeconds": { "type": "integer" }, "readTimeoutSeconds": { "type": "integer" }, "isActive": { "type": "string" } } } } } }, "ListNsRestletConfigsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.list#NsRestletConfigs", "x-darpan-method": "facade.SettingsFacadeServices.list#NsRestletConfigs", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.list#NsRestletConfigs" }, "params": { "$ref": "#/components/schemas/ListNsRestletConfigsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListNsRestletConfigsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.list#NsRestletConfigs. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListNsRestletConfigsResult" } }, "required": [ "jsonrpc", "result" ] }, "ListSftpServersParams": { "type": "object", "properties": { "query": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List SFTP server configs with secret redaction indicators." }, "ListSftpServersResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "servers": { "type": "array", "items": { "type": "object", "properties": { "sftpServerId": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": "string" }, "remoteAttributes": { "type": "string" }, "hasPassword": { "type": "boolean" }, "hasPrivateKey": { "type": "boolean" } } } } } }, "ListSftpServersRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.list#SftpServers", "x-darpan-method": "facade.SettingsFacadeServices.list#SftpServers", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.list#SftpServers" }, "params": { "$ref": "#/components/schemas/ListSftpServersParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListSftpServersResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.list#SftpServers. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListSftpServersResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveLlmSettingsParams": { "type": "object", "properties": { "llmProvider": { "type": "string" }, "llmApiKey": { "type": "string" }, "llmModel": { "type": "string" }, "llmBaseUrl": { "type": "string" }, "llmTimeoutSeconds": { "type": "string" }, "llmEnabled": { "type": "string" } }, "required": [ "llmProvider" ], "description": "Save LLM provider settings while preserving existing key when blank." }, "SaveLlmSettingsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "llmSettings": { "type": "object", "properties": { "activeProvider": { "type": "string" }, "llmProvider": { "type": "string" }, "llmModel": { "type": "string" }, "llmBaseUrl": { "type": "string" }, "llmTimeoutSeconds": { "type": "string" }, "llmEnabled": { "type": "string" }, "hasStoredLlmApiKey": { "type": "boolean" } } } } }, "SaveLlmSettingsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.save#LlmSettings", "x-darpan-method": "facade.SettingsFacadeServices.save#LlmSettings", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.save#LlmSettings" }, "params": { "$ref": "#/components/schemas/SaveLlmSettingsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveLlmSettingsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.save#LlmSettings. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveLlmSettingsResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveNsAuthConfigParams": { "type": "object", "properties": { "nsAuthConfigId": { "type": "string" }, "description": { "type": "string" }, "authType": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "apiToken": { "type": "string" }, "tokenUrl": { "type": "string" }, "clientId": { "type": "string" }, "certId": { "type": "string" }, "scope": { "type": "string" }, "privateKeyPem": { "type": "string" }, "isActive": { "type": "boolean" } }, "required": [ "nsAuthConfigId" ], "description": "Create or update a NetSuite auth configuration." }, "SaveNsAuthConfigResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedAuthConfig": { "type": "object", "properties": { "nsAuthConfigId": { "type": "string" }, "description": { "type": "string" }, "authType": { "type": "string" }, "username": { "type": "string" }, "tokenUrl": { "type": "string" }, "clientId": { "type": "string" }, "certId": { "type": "string" }, "scope": { "type": "string" }, "isActive": { "type": "string" }, "hasPassword": { "type": "boolean" }, "hasApiToken": { "type": "boolean" }, "hasPrivateKeyPem": { "type": "boolean" } } } } }, "SaveNsAuthConfigRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.save#NsAuthConfig", "x-darpan-method": "facade.SettingsFacadeServices.save#NsAuthConfig", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.save#NsAuthConfig" }, "params": { "$ref": "#/components/schemas/SaveNsAuthConfigParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveNsAuthConfigResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.save#NsAuthConfig. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveNsAuthConfigResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveNsRestletConfigParams": { "type": "object", "properties": { "nsRestletConfigId": { "type": "string" }, "description": { "type": "string" }, "endpointUrl": { "type": "string" }, "httpMethod": { "type": "string" }, "nsAuthConfigId": { "type": "string" }, "headersJson": { "type": "string" }, "connectTimeoutSeconds": { "type": "integer" }, "readTimeoutSeconds": { "type": "integer" }, "isActive": { "type": "boolean" } }, "required": [ "nsRestletConfigId", "endpointUrl", "nsAuthConfigId" ], "description": "Create or update a NetSuite endpoint configuration bound to an auth config." }, "SaveNsRestletConfigResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedRestletConfig": { "type": "object", "properties": { "nsRestletConfigId": { "type": "string" }, "description": { "type": "string" }, "endpointUrl": { "type": "string" }, "httpMethod": { "type": "string" }, "nsAuthConfigId": { "type": "string" }, "headersJson": { "type": "string" }, "connectTimeoutSeconds": { "type": "integer" }, "readTimeoutSeconds": { "type": "integer" }, "isActive": { "type": "string" } } } } }, "SaveNsRestletConfigRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.save#NsRestletConfig", "x-darpan-method": "facade.SettingsFacadeServices.save#NsRestletConfig", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.save#NsRestletConfig" }, "params": { "$ref": "#/components/schemas/SaveNsRestletConfigParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveNsRestletConfigResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.save#NsRestletConfig. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveNsRestletConfigResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveSftpServerParams": { "type": "object", "properties": { "sftpServerId": { "type": "string" }, "description": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": "string" }, "password": { "type": "string" }, "privateKey": { "type": "string" }, "remoteAttributes": { "type": "boolean" } }, "required": [ "sftpServerId", "host", "username" ], "description": "Create or update an SFTP server configuration." }, "SaveSftpServerResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedServer": { "type": "object", "properties": { "sftpServerId": { "type": "string" }, "description": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": "string" }, "remoteAttributes": { "type": "string" }, "hasPassword": { "type": "boolean" }, "hasPrivateKey": { "type": "boolean" } } } } }, "SaveSftpServerRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.save#SftpServer", "x-darpan-method": "facade.SettingsFacadeServices.save#SftpServer", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.save#SftpServer" }, "params": { "$ref": "#/components/schemas/SaveSftpServerParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveSftpServerResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.save#SftpServer. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveSftpServerResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveTenantNotificationSettingsParams": { "type": "object", "properties": { "googleChatWebhookUrl": { "type": "string" }, "isActive": { "type": "boolean" } }, "description": "Save one Google Chat run-completion webhook for the active tenant." }, "SaveTenantNotificationSettingsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "tenantNotificationSettings": { "type": "object", "properties": { "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "googleChatConfigured": { "type": "boolean" }, "googleChatWebhookUrlMasked": { "type": "string" }, "isActive": { "type": "string" }, "createdByUserId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastUpdatedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } }, "SaveTenantNotificationSettingsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.save#TenantNotificationSettings", "x-darpan-method": "facade.SettingsFacadeServices.save#TenantNotificationSettings", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.save#TenantNotificationSettings" }, "params": { "$ref": "#/components/schemas/SaveTenantNotificationSettingsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveTenantNotificationSettingsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.save#TenantNotificationSettings. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveTenantNotificationSettingsResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveTenantSettingsParams": { "type": "object", "properties": { "timeZone": { "type": "string", "description": "Timezone identifier for the active tenant, such as UTC or America/Los_Angeles." } }, "required": [ "timeZone" ], "description": "Save active-tenant settings shared by users in the tenant." }, "SaveTenantSettingsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "tenantSettings": { "type": "object", "properties": { "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "timeZone": { "type": "string" }, "createdByUserId": { "type": "string" }, "createdDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" }, "lastUpdatedDate": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Timestamp \u2014 ISO-8601 string or epoch milliseconds" } } } } }, "SaveTenantSettingsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.SettingsFacadeServices.save#TenantSettings", "x-darpan-method": "facade.SettingsFacadeServices.save#TenantSettings", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.SettingsFacadeServices.save#TenantSettings" }, "params": { "$ref": "#/components/schemas/SaveTenantSettingsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveTenantSettingsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.SettingsFacadeServices.save#TenantSettings. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveTenantSettingsResult" } }, "required": [ "jsonrpc", "result" ] }, "DeleteShopifyAuthConfigParams": { "type": "object", "properties": { "shopifyAuthConfigId": { "type": "string" } }, "required": [ "shopifyAuthConfigId" ], "description": "Delete one tenant-owned Shopify auth config." }, "DeleteShopifyAuthConfigResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "deleted": { "type": "boolean" }, "deletedShopifyAuthConfigId": { "type": "string" } } }, "DeleteShopifyAuthConfigRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ShopifyFacadeServices.delete#ShopifyAuthConfig", "x-darpan-method": "facade.ShopifyFacadeServices.delete#ShopifyAuthConfig", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ShopifyFacadeServices.delete#ShopifyAuthConfig" }, "params": { "$ref": "#/components/schemas/DeleteShopifyAuthConfigParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "DeleteShopifyAuthConfigResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ShopifyFacadeServices.delete#ShopifyAuthConfig. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/DeleteShopifyAuthConfigResult" } }, "required": [ "jsonrpc", "result" ] }, "GetShopifyAuthConfigParams": { "type": "object", "properties": { "shopifyAuthConfigId": { "type": "string" } }, "required": [ "shopifyAuthConfigId" ], "description": "Get one Shopify auth config for the active tenant with the access token redacted." }, "GetShopifyAuthConfigResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "shopifyAuthConfig": { "type": "object", "properties": { "shopifyAuthConfigId": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "createdByUserId": { "type": "string" }, "shopApiUrl": { "type": "string" }, "apiVersion": { "type": "string" }, "timeZone": { "type": "string" }, "isActive": { "type": "string" }, "canReadOrders": { "type": "boolean" }, "hasAccessToken": { "type": "boolean" } } } } }, "GetShopifyAuthConfigRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ShopifyFacadeServices.get#ShopifyAuthConfig", "x-darpan-method": "facade.ShopifyFacadeServices.get#ShopifyAuthConfig", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ShopifyFacadeServices.get#ShopifyAuthConfig" }, "params": { "$ref": "#/components/schemas/GetShopifyAuthConfigParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "GetShopifyAuthConfigResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ShopifyFacadeServices.get#ShopifyAuthConfig. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/GetShopifyAuthConfigResult" } }, "required": [ "jsonrpc", "result" ] }, "ListShopifyAuthConfigsParams": { "type": "object", "properties": { "query": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" } }, "description": "List Shopify auth configs for the active tenant with secret redaction indicators." }, "ListShopifyAuthConfigsResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "pageCount": { "type": "integer" } } }, "shopifyAuthConfigs": { "type": "array", "items": { "type": "object", "properties": { "shopifyAuthConfigId": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "createdByUserId": { "type": "string" }, "shopApiUrl": { "type": "string" }, "apiVersion": { "type": "string" }, "timeZone": { "type": "string" }, "isActive": { "type": "string" }, "canReadOrders": { "type": "boolean" }, "hasAccessToken": { "type": "boolean" } } } } } }, "ListShopifyAuthConfigsRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ShopifyFacadeServices.list#ShopifyAuthConfigs", "x-darpan-method": "facade.ShopifyFacadeServices.list#ShopifyAuthConfigs", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ShopifyFacadeServices.list#ShopifyAuthConfigs" }, "params": { "$ref": "#/components/schemas/ListShopifyAuthConfigsParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "ListShopifyAuthConfigsResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ShopifyFacadeServices.list#ShopifyAuthConfigs. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/ListShopifyAuthConfigsResult" } }, "required": [ "jsonrpc", "result" ] }, "SaveShopifyAuthConfigParams": { "type": "object", "properties": { "shopifyAuthConfigId": { "type": "string" }, "description": { "type": "string" }, "shopApiUrl": { "type": "string" }, "apiVersion": { "type": "string" }, "timeZone": { "type": "string" }, "accessToken": { "type": "string" }, "isActive": { "type": "string" }, "canReadOrders": { "type": "string" } }, "required": [ "shopifyAuthConfigId", "shopApiUrl", "apiVersion" ], "description": "Create or update a tenant-owned Shopify auth config, preserving the stored token when no replacement is provided." }, "SaveShopifyAuthConfigResult": { "type": "object", "properties": { "ok": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } }, "savedShopifyAuthConfig": { "type": "object", "properties": { "shopifyAuthConfigId": { "type": "string" }, "description": { "type": "string" }, "companyUserGroupId": { "type": "string" }, "companyLabel": { "type": "string" }, "createdByUserId": { "type": "string" }, "shopApiUrl": { "type": "string" }, "apiVersion": { "type": "string" }, "timeZone": { "type": "string" }, "isActive": { "type": "string" }, "canReadOrders": { "type": "boolean" }, "hasAccessToken": { "type": "boolean" } } } } }, "SaveShopifyAuthConfigRequest": { "type": "object", "description": "JSON-RPC request envelope for facade.ShopifyFacadeServices.save#ShopifyAuthConfig", "x-darpan-method": "facade.ShopifyFacadeServices.save#ShopifyAuthConfig", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "method": { "type": "string", "const": "facade.ShopifyFacadeServices.save#ShopifyAuthConfig" }, "params": { "$ref": "#/components/schemas/SaveShopifyAuthConfigParams" } }, "required": [ "jsonrpc", "id", "method" ] }, "SaveShopifyAuthConfigResponse": { "type": "object", "description": "JSON-RPC success envelope for facade.ShopifyFacadeServices.save#ShopifyAuthConfig. Check result.ok / result.errors for business failures.", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "result": { "$ref": "#/components/schemas/SaveShopifyAuthConfigResult" } }, "required": [ "jsonrpc", "result" ] } } }, "x-darpan-methods": { "facade.AuthFacadeServices.change#OwnPassword": "ChangeOwnPassword", "facade.AuthFacadeServices.get#SessionInfo": "GetSessionInfo", "facade.AuthFacadeServices.login#Session": "LoginSession", "facade.AuthFacadeServices.logout#AllSessions": "LogoutAllSessions", "facade.AuthFacadeServices.logout#Session": "LogoutSession", "facade.AuthFacadeServices.save#ActiveTenant": "SaveActiveTenant", "facade.AuthFacadeServices.save#UserSettings": "SaveUserSettings", "facade.AuthFacadeServices.verify#OwnPassword": "VerifyOwnPassword", "facade.HotWaxOmsFacadeServices.delete#HotWaxOmsRestSourceConfig": "DeleteHotWaxOmsRestSourceConfig", "facade.HotWaxOmsFacadeServices.list#HotWaxOmsRestSourceConfigs": "ListHotWaxOmsRestSourceConfigs", "facade.HotWaxOmsFacadeServices.save#HotWaxOmsRestSourceConfig": "SaveHotWaxOmsRestSourceConfig", "facade.JsonSchemaFacadeServices.delete#JsonSchema": "DeleteJsonSchema", "facade.JsonSchemaFacadeServices.flatten#JsonSchema": "FlattenJsonSchema", "facade.JsonSchemaFacadeServices.get#JsonSchema": "GetJsonSchema", "facade.JsonSchemaFacadeServices.infer#JsonSchemaFromText": "InferJsonSchemaFromText", "facade.JsonSchemaFacadeServices.list#JsonSchemas": "ListJsonSchemas", "facade.JsonSchemaFacadeServices.save#JsonSchemaText": "SaveJsonSchemaText", "facade.JsonSchemaFacadeServices.save#RefinedSchema": "SaveRefinedSchema", "facade.JsonSchemaFacadeServices.validate#JsonTextAgainstSchema": "ValidateJsonTextAgainstSchema", "facade.ReconciliationFacadeServices.create#CsvRun": "CreateCsvRun", "facade.ReconciliationFacadeServices.create#Mapping": "CreateMapping", "facade.ReconciliationFacadeServices.create#RuleSetRun": "CreateRuleSetRun", "facade.ReconciliationFacadeServices.delete#Automation": "DeleteAutomation", "facade.ReconciliationFacadeServices.delete#GeneratedOutput": "DeleteGeneratedOutput", "facade.ReconciliationFacadeServices.delete#SavedRun": "DeleteSavedRun", "facade.ReconciliationFacadeServices.get#Automation": "GetAutomation", "facade.ReconciliationFacadeServices.get#GeneratedOutput": "GetGeneratedOutput", "facade.ReconciliationFacadeServices.get#GeneratedOutputDifferences": "GetGeneratedOutputDifferences", "facade.ReconciliationFacadeServices.get#Mapping": "GetMapping", "facade.ReconciliationFacadeServices.list#AutomationExecutions": "ListAutomationExecutions", "facade.ReconciliationFacadeServices.list#AutomationSourceOptions": "ListAutomationSourceOptions", "facade.ReconciliationFacadeServices.list#Automations": "ListAutomations", "facade.ReconciliationFacadeServices.list#GeneratedOutputs": "ListGeneratedOutputs", "facade.ReconciliationFacadeServices.list#Mappings": "ListMappings", "facade.ReconciliationFacadeServices.list#SavedRuns": "ListSavedRuns", "facade.ReconciliationFacadeServices.pause#Automation": "PauseAutomation", "facade.ReconciliationFacadeServices.reprocess#AutomationExecution": "ReprocessAutomationExecution", "facade.ReconciliationFacadeServices.resume#Automation": "ResumeAutomation", "facade.ReconciliationFacadeServices.run#AutomationNow": "RunAutomationNow", "facade.ReconciliationFacadeServices.run#GenericDiff": "RunGenericDiff", "facade.ReconciliationFacadeServices.run#SavedRunDiff": "RunSavedRunDiff", "facade.ReconciliationFacadeServices.save#Automation": "SaveAutomation", "facade.ReconciliationFacadeServices.save#DashboardPinnedMappings": "SaveDashboardPinnedMappings", "facade.ReconciliationFacadeServices.save#DashboardPinnedSavedRuns": "SaveDashboardPinnedSavedRuns", "facade.ReconciliationFacadeServices.save#Mapping": "SaveMapping", "facade.ReconciliationFacadeServices.save#RuleSetRun": "SaveRuleSetRun", "facade.ReconciliationFacadeServices.save#SavedRunName": "SaveSavedRunName", "facade.SearchFacadeServices.search#NavigationTargets": "SearchNavigationTargets", "facade.SettingsFacadeServices.get#LlmSettings": "GetLlmSettings", "facade.SettingsFacadeServices.get#TenantNotificationSettings": "GetTenantNotificationSettings", "facade.SettingsFacadeServices.get#TenantSettings": "GetTenantSettings", "facade.SettingsFacadeServices.list#EnumOptions": "ListEnumOptions", "facade.SettingsFacadeServices.list#NsAuthConfigs": "ListNsAuthConfigs", "facade.SettingsFacadeServices.list#NsRestletConfigs": "ListNsRestletConfigs", "facade.SettingsFacadeServices.list#SftpServers": "ListSftpServers", "facade.SettingsFacadeServices.save#LlmSettings": "SaveLlmSettings", "facade.SettingsFacadeServices.save#NsAuthConfig": "SaveNsAuthConfig", "facade.SettingsFacadeServices.save#NsRestletConfig": "SaveNsRestletConfig", "facade.SettingsFacadeServices.save#SftpServer": "SaveSftpServer", "facade.SettingsFacadeServices.save#TenantNotificationSettings": "SaveTenantNotificationSettings", "facade.SettingsFacadeServices.save#TenantSettings": "SaveTenantSettings", "facade.ShopifyFacadeServices.delete#ShopifyAuthConfig": "DeleteShopifyAuthConfig", "facade.ShopifyFacadeServices.get#ShopifyAuthConfig": "GetShopifyAuthConfig", "facade.ShopifyFacadeServices.list#ShopifyAuthConfigs": "ListShopifyAuthConfigs", "facade.ShopifyFacadeServices.save#ShopifyAuthConfig": "SaveShopifyAuthConfig" } }