{ "openapi": "3.0.0", "info": { "title": "clear-ercapi", "version": "3.7.324", "description": "ClearERCAPI", "contact": { "name": "Matthew Riddell", "email": "matt@.ai" } }, "paths": { "/affiliate-contracts/{id}": { "patch": { "x-controller-name": "AffiliateContractController", "x-operation-name": "updateById", "tags": [ "AffiliateContractController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Affiliate Contract PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateContractPartial" } } }, "x-parameter-index": 1 }, "operationId": "AffiliateContractController.updateById" }, "get": { "x-controller-name": "AffiliateContractController", "x-operation-name": "findById", "tags": [ "AffiliateContractController" ], "responses": { "200": { "description": "AffiliateContract model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateContractWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateContract.Filter" } } } } ], "operationId": "AffiliateContractController.findById" } }, "/affiliate-contracts": { "post": { "x-controller-name": "AffiliateContractController", "x-operation-name": "create", "tags": [ "AffiliateContractController" ], "responses": { "200": { "description": "AffiliateContract model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateContract" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAffiliateContract" } } } }, "operationId": "AffiliateContractController.create" }, "get": { "x-controller-name": "AffiliateContractController", "x-operation-name": "find", "tags": [ "AffiliateContractController" ], "responses": { "200": { "description": "Affiliate contract model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AffiliateContractWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateContract.Filter1" } } } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "operationId": "AffiliateContractController.find" } }, "/affiliate-imports/commit": { "post": { "x-controller-name": "AffiliateImportsController", "x-operation-name": "commit", "tags": [ "AffiliateImportsController" ], "responses": { "200": { "description": "Import report: created / existing / invitesQueued / skipped rows", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitAffiliateImport" } } } }, "operationId": "AffiliateImportsController.commit" } }, "/affiliate-imports/parse": { "post": { "x-controller-name": "AffiliateImportsController", "x-operation-name": "parse", "tags": [ "AffiliateImportsController" ], "responses": { "200": { "description": "Detected headers, sample rows and a suggested column mapping", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParseAffiliateImport" } } } }, "operationId": "AffiliateImportsController.parse" } }, "/affiliate-org/leaderboard": { "get": { "x-controller-name": "AffiliateOrgController", "x-operation-name": "leaderboard", "tags": [ "AffiliateOrgController" ], "responses": { "200": { "description": "Top downline producers with previous-period rank movement", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "metric", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "AffiliateOrgController.leaderboard" } }, "/affiliate-org/roster": { "get": { "x-controller-name": "AffiliateOrgController", "x-operation-name": "roster", "tags": [ "AffiliateOrgController" ], "responses": { "200": { "description": "A page of the downline roster plus the filtered total", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "sortField", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } } ], "operationId": "AffiliateOrgController.roster" } }, "/affiliate-org/stats": { "get": { "x-controller-name": "AffiliateOrgController", "x-operation-name": "stats", "tags": [ "AffiliateOrgController" ], "responses": { "200": { "description": "Headline stats for the caller’s affiliate downline", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "AffiliateOrgController.stats" } }, "/alert-rule-channels/{id}": { "get": { "x-controller-name": "AlertRuleChannelController", "x-operation-name": "findById", "tags": [ "AlertRuleChannelController" ], "responses": { "200": { "description": "Alert Rule Channels model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleChannelWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleChannel.Filter" } } } } ], "operationId": "AlertRuleChannelController.findById" } }, "/alert-rule-channels": { "post": { "x-controller-name": "AlertRuleChannelController", "x-operation-name": "create", "tags": [ "AlertRuleChannelController" ], "responses": { "200": { "description": "Alert Rule Channel model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleChannel" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAlertRuleChannel" } } } }, "operationId": "AlertRuleChannelController.create" }, "get": { "x-controller-name": "AlertRuleChannelController", "x-operation-name": "find", "tags": [ "AlertRuleChannelController" ], "responses": { "200": { "description": "Alert Rule Channels model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertRuleChannelWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleChannel.Filter1" } } } } ], "operationId": "AlertRuleChannelController.find" } }, "/alert-rules/setup": { "post": { "x-controller-name": "AlertRuleController", "x-operation-name": "setup", "tags": [ "AlertRuleController" ], "responses": { "200": { "description": "Alert Rules and Channels setup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "alertTypeId": { "type": "number" }, "title": { "type": "string" }, "body": { "type": "string" }, "conditions": { "type": "object" }, "channels": { "type": "array", "items": { "properties": { "channel": { "type": "string" }, "channelId": { "type": "string" }, "link": { "type": "string" }, "recipients": { "type": "string" } } } } } } } } }, "operationId": "AlertRuleController.setup" } }, "/alert-rules/{id}/setup": { "patch": { "x-controller-name": "AlertRuleController", "x-operation-name": "setupPatch", "tags": [ "AlertRuleController" ], "responses": { "200": { "description": "Alert Rules and Channels setup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "alertTypeId": { "type": "number" }, "title": { "type": "string" }, "body": { "type": "string" }, "conditions": { "type": "object" }, "channels": { "type": "array", "items": { "properties": { "channel": { "type": "string" }, "channelId": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true }, "recipients": { "type": "string", "nullable": true } } } } } } } }, "x-parameter-index": 1 }, "operationId": "AlertRuleController.setupPatch" }, "delete": { "x-controller-name": "AlertRuleController", "x-operation-name": "deleteById", "tags": [ "AlertRuleController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete alert rule, channels and settings" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AlertRuleController.deleteById" } }, "/alert-rules/{id}": { "get": { "x-controller-name": "AlertRuleController", "x-operation-name": "findById", "tags": [ "AlertRuleController" ], "responses": { "200": { "description": "Alert Rules model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule.Filter" } } } } ], "operationId": "AlertRuleController.findById" } }, "/alert-rules": { "post": { "x-controller-name": "AlertRuleController", "x-operation-name": "create", "tags": [ "AlertRuleController" ], "responses": { "200": { "description": "Alert Rules model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAlertRule" } } } }, "operationId": "AlertRuleController.create" }, "get": { "x-controller-name": "AlertRuleController", "x-operation-name": "find", "tags": [ "AlertRuleController" ], "responses": { "200": { "description": "Alert Rules model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertRuleWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule.Filter1" } } } } ], "operationId": "AlertRuleController.find" } }, "/alert-types/{id}": { "get": { "x-controller-name": "AlertTypeController", "x-operation-name": "findById", "tags": [ "AlertTypeController" ], "responses": { "200": { "description": "Alert Type model instance", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AlertTypeWithRelations" }, { "type": "object", "properties": { "isInternal": { "type": "boolean" } } } ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertType.Filter" } } } } ], "operationId": "AlertTypeController.findById" } }, "/alert-types": { "post": { "x-controller-name": "AlertTypeController", "x-operation-name": "create", "tags": [ "AlertTypeController" ], "responses": { "200": { "description": "Alert Types model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertType" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAlertType" } } } }, "operationId": "AlertTypeController.create" }, "get": { "x-controller-name": "AlertTypeController", "x-operation-name": "find", "tags": [ "AlertTypeController" ], "responses": { "200": { "description": "Alert Type model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AlertTypeWithRelations" }, { "type": "object", "properties": { "isInternal": { "type": "boolean" } } } ] } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertType.Filter1" } } } } ], "operationId": "AlertTypeController.find" } }, "/alert-user-settings": { "post": { "x-controller-name": "AlertUserSettingsController", "x-operation-name": "create", "tags": [ "AlertUserSettingsController" ], "responses": { "200": { "description": "Alert User Settings model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertUserSettings" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAlertUserSettings" } } } }, "operationId": "AlertUserSettingsController.create" }, "patch": { "x-controller-name": "AlertUserSettingsController", "x-operation-name": "updateByUserId", "tags": [ "AlertUserSettingsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Alert User Settings PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertUserSettingsPartial" } } }, "x-parameter-index": 1 }, "operationId": "AlertUserSettingsController.updateByUserId" }, "get": { "x-controller-name": "AlertUserSettingsController", "x-operation-name": "find", "tags": [ "AlertUserSettingsController" ], "responses": { "200": { "description": "Alert User Settings model instances", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AlertUserSettingsWithRelations", "definitions": { "AlertUserSettingsWithRelations": { "$ref": "#/components/schemas/AlertUserSettingsWithRelations" } } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertUserSettings.Filter" } } } } ], "operationId": "AlertUserSettingsController.find" } }, "/alerts/from-processflow-entry": { "post": { "x-controller-name": "AlertController", "x-operation-name": "createFromProcessflowEntry", "tags": [ "AlertController" ], "responses": { "200": { "description": "Number of alerts dispatched from the entry configuration", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "processflowId", "field" ], "properties": { "processflowId": { "type": "number" }, "field": { "type": "string" }, "companyId": { "type": "number" } } } } } }, "operationId": "AlertController.createFromProcessflowEntry" } }, "/alerts/sample-previews": { "get": { "x-controller-name": "AlertSamplesController", "x-operation-name": "samplePreviews", "tags": [ "AlertSamplesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Rendered email + SMS previews for every alert type" } } } } }, "operationId": "AlertSamplesController.samplePreviews" } }, "/alerts/send-samples-to-me": { "post": { "x-controller-name": "AlertSamplesController", "x-operation-name": "sendSamplesToMe", "tags": [ "AlertSamplesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Summary of the samples sent to the caller" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string" } } } } } }, "required": false }, "operationId": "AlertSamplesController.sendSamplesToMe" } }, "/alerts/send-test": { "post": { "x-controller-name": "AlertSamplesController", "x-operation-name": "sendTest", "tags": [ "AlertSamplesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Result of sending one event as a test to a typed recipient" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "channels": { "type": "array", "items": { "type": "string" } } } } } } }, "operationId": "AlertSamplesController.sendTest" } }, "/alerts/{id}": { "patch": { "x-controller-name": "AlertController", "x-operation-name": "updateByUserId", "tags": [ "AlertController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Alerts PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertPartial" } } }, "x-parameter-index": 1 }, "operationId": "AlertController.updateByUserId" }, "delete": { "x-controller-name": "AlertController", "x-operation-name": "deleteById", "tags": [ "AlertController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Alert DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AlertController.deleteById" } }, "/alerts": { "post": { "x-controller-name": "AlertController", "x-operation-name": "create", "tags": [ "AlertController" ], "responses": { "200": { "description": "Alert model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAlert" } } } }, "operationId": "AlertController.create" }, "get": { "x-controller-name": "AlertController", "x-operation-name": "find", "tags": [ "AlertController" ], "responses": { "200": { "description": "Alert model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert.Filter" } } } } ], "operationId": "AlertController.find" } }, "/all-census-runs": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "listAllCensusRuns", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "One page of census imports across all companies (newest first) plus the unpaginated total, each row with its analysis-run summary", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } } ], "operationId": "S125AnalyzerController.listAllCensusRuns" } }, "/analysis-runs/{id}/benefit-summary": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "getAnalysisRunBenefitSummary", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The Benefit Summary header block for a run" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "mode", "in": "query", "schema": { "type": "string" } } ], "operationId": "S125AnalyzerController.getAnalysisRunBenefitSummary" } }, "/analysis-runs/{id}/distribute-pay-comparisons": { "post": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "distributePayComparisonsForRun", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-employee pay-comparison filing summary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "mode", "in": "query", "schema": { "type": "string" } } ], "operationId": "S125AnalyzerController.distributePayComparisonsForRun" } }, "/analysis-runs/{id}/employee-detail": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "getAnalysisRunEmployeeDetail", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The per-employee Employee Detail rows for a run" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "qualifiedOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "nameSearch", "in": "query", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "schema": { "type": "string" } } ], "operationId": "S125AnalyzerController.getAnalysisRunEmployeeDetail" } }, "/analysis-runs/{id}/exports/{exportType}": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "downloadAnalysisRunExport", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "exportType", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "mode", "in": "query", "schema": { "type": "string" } } ], "operationId": "S125AnalyzerController.downloadAnalysisRunExport" } }, "/analysis-runs/{id}/plan-model": { "post": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "modelPlan", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The ephemeral plan what-if modeling summary for a run" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "mode", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "deductionPerMonth", "claimPaymentPerMonth" ], "additionalProperties": false, "properties": { "deductionPerMonth": { "type": "number" }, "claimPaymentPerMonth": { "type": "number" }, "minExcessPerPayPeriod": { "type": "number" } } } } }, "required": true, "x-parameter-index": 1 }, "operationId": "S125AnalyzerController.modelPlan" } }, "/analysis-runs/{id}/report": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "getAnalysisRunReport", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The AnalysisRunReport payload for a run" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "mode", "in": "query", "schema": { "type": "string" } } ], "operationId": "S125AnalyzerController.getAnalysisRunReport" } }, "/analysis-runs/{id}": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "getAnalysisRun", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "A single analysis run", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisRun" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "S125AnalyzerController.getAnalysisRun" } }, "/appointment-dispositions": { "put": { "x-controller-name": "AppointmentDispositionController", "x-operation-name": "upsert", "tags": [ "AppointmentDispositionController" ], "responses": { "200": { "description": "Record or change an appointment outcome (upsert by bookingUid). An 'interested' outcome also converts the prospect, grants access, and advances the company to the next employer phase when its current phase is one a go-ahead can move (board #4018/#4024).", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "bookingUid", "prospectId", "outcome" ], "properties": { "bookingUid": { "type": "string" }, "prospectId": { "type": "number" }, "outcome": { "type": "string", "enum": [ "interested", "not_interested", "no_show", "follow_up" ] } } } } } }, "operationId": "AppointmentDispositionController.upsert" }, "get": { "x-controller-name": "AppointmentDispositionController", "x-operation-name": "find", "tags": [ "AppointmentDispositionController" ], "responses": { "200": { "description": "Appointment dispositions matching the filter. A non-super caller — a sales rep or, since board #4047, an affiliate — only ever reads their own.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppointmentDisposition" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentDisposition.Filter" } } } } ], "operationId": "AppointmentDispositionController.find" } }, "/appointments/count": { "get": { "x-controller-name": "AppointmentsController", "x-operation-name": "count", "tags": [ "AppointmentsController" ], "responses": { "200": { "description": "Appointments model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Appointments.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "AppointmentsController.count" } }, "/appointments/{id}": { "put": { "x-controller-name": "AppointmentsController", "x-operation-name": "replaceById", "tags": [ "AppointmentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Appointments PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointments" } } }, "x-parameter-index": 1 }, "operationId": "AppointmentsController.replaceById" }, "patch": { "x-controller-name": "AppointmentsController", "x-operation-name": "updateById", "tags": [ "AppointmentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Appointments PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentsPartial" } } }, "x-parameter-index": 1 }, "operationId": "AppointmentsController.updateById" }, "get": { "x-controller-name": "AppointmentsController", "x-operation-name": "findById", "tags": [ "AppointmentsController" ], "responses": { "200": { "description": "Appointments model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointments.Filter" } } } } ], "operationId": "AppointmentsController.findById" }, "delete": { "x-controller-name": "AppointmentsController", "x-operation-name": "deleteById", "tags": [ "AppointmentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Appointments DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AppointmentsController.deleteById" } }, "/appointments": { "post": { "x-controller-name": "AppointmentsController", "x-operation-name": "create", "tags": [ "AppointmentsController" ], "responses": { "200": { "description": "Appointments model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointments" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAppointments" } } } }, "operationId": "AppointmentsController.create" }, "patch": { "x-controller-name": "AppointmentsController", "x-operation-name": "updateAll", "tags": [ "AppointmentsController" ], "responses": { "200": { "description": "Appointments PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Appointments.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentsPartial" } } } }, "operationId": "AppointmentsController.updateAll" }, "get": { "x-controller-name": "AppointmentsController", "x-operation-name": "find", "tags": [ "AppointmentsController" ], "responses": { "200": { "description": "Array of Appointments model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppointmentsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointments.Filter1" } } } } ], "operationId": "AppointmentsController.find" } }, "/balance-of-accounts/{companyId}/entries": { "get": { "x-controller-name": "BalanceOfAccountsController", "x-operation-name": "entries", "tags": [ "BalanceOfAccountsController" ], "responses": { "200": { "description": "The posting rows behind a company's balance (paginated, newest first) — the balance is provably the sum of these entries", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerPosting" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "account", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } } ], "operationId": "BalanceOfAccountsController.entries" } }, "/balance-of-accounts": { "get": { "x-controller-name": "BalanceOfAccountsController", "x-operation-name": "balances", "tags": [ "BalanceOfAccountsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-company receivable/payable/settledIn/settledOut, summed from ledger_postings" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "BalanceOfAccountsController.balances" } }, "/benefit-enrollments/mine": { "get": { "x-controller-name": "BenefitEnrollmentsController", "x-operation-name": "mine", "tags": [ "BenefitEnrollmentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The caller's current derived enrollment state" } } } } }, "operationId": "BenefitEnrollmentsController.mine" } }, "/benefit-enrollments/{id}/close": { "post": { "x-controller-name": "BenefitEnrollmentsController", "x-operation-name": "close", "tags": [ "BenefitEnrollmentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The closed enrollment span" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "BenefitEnrollmentsController.close" } }, "/benefit-enrollments": { "post": { "x-controller-name": "BenefitEnrollmentsController", "x-operation-name": "open", "tags": [ "BenefitEnrollmentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The opened enrollment span" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "employeeUserId", "companyId", "source" ], "properties": { "employeeUserId": { "type": "string" }, "companyId": { "type": "number" }, "source": { "type": "string", "enum": [ "staff", "self" ] } } } } } }, "operationId": "BenefitEnrollmentsController.open" } }, "/billing-reconciliation/runs": { "get": { "x-controller-name": "BillingReconciliationController", "x-operation-name": "runs", "tags": [ "BillingReconciliationController" ], "responses": { "200": { "description": "Recent persisted reconciliation runs, newest first", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingReconciliationRun" } } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "BillingReconciliationController.runs" } }, "/billing-reconciliation": { "get": { "x-controller-name": "BillingReconciliationController", "x-operation-name": "live", "tags": [ "BillingReconciliationController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Live legacy-vs-new parity report" } } } } }, "operationId": "BillingReconciliationController.live" } }, "/billing-rosters/{id}": { "put": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "editRoster", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.editRoster" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PerLifeBillingController.editRoster" }, "delete": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "deleteRoster", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.deleteRoster" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PerLifeBillingController.deleteRoster" } }, "/billing-settings": { "put": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "putBillingSettings", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.putBillingSettings" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "PerLifeBillingController.putBillingSettings" }, "get": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "getBillingSettings", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.getBillingSettings" } }, "operationId": "PerLifeBillingController.getBillingSettings" } }, "/blog-cms/articles/{slug}/images": { "post": { "x-controller-name": "BlogCmsController", "x-operation-name": "uploadImage", "tags": [ "BlogCmsController" ], "responses": { "200": { "description": "The committed image: public path, dimensions, and byte size", "content": { "application/json": { "schema": { "type": "object", "properties": { "path": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "size": { "type": "number" }, "commitSha": { "type": "string" } } } } } } }, "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "name", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 2 }, "operationId": "BlogCmsController.uploadImage" } }, "/blog-cms/articles/{slug}/published": { "put": { "x-controller-name": "BlogCmsController", "x-operation-name": "setPublished", "tags": [ "BlogCmsController" ], "responses": { "200": { "description": "The article slug and its new published state", "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" }, "published": { "type": "boolean" }, "commitSha": { "type": "string" } } } } } } }, "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "published" ], "properties": { "published": { "type": "boolean" } } } } }, "x-parameter-index": 1 }, "operationId": "BlogCmsController.setPublished" } }, "/blog-cms/articles/{slug}": { "put": { "x-controller-name": "BlogCmsController", "x-operation-name": "saveArticle", "tags": [ "BlogCmsController" ], "responses": { "200": { "description": "The article as saved (sanitized), plus its new git blob sha", "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "date": { "type": "string" }, "author": { "type": "string" }, "published": { "type": "boolean" }, "bodyHtml": { "type": "string" }, "sha": { "type": "string" }, "commitSha": { "type": "string" } } } } } } }, "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "description", "image", "date", "bodyHtml" ], "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "date": { "type": "string" }, "author": { "type": "string" }, "bodyHtml": { "type": "string" }, "expectedSha": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "BlogCmsController.saveArticle" }, "get": { "x-controller-name": "BlogCmsController", "x-operation-name": "getArticle", "tags": [ "BlogCmsController" ], "responses": { "200": { "description": "One article, body included, plus its git blob sha", "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "date": { "type": "string" }, "author": { "type": "string" }, "published": { "type": "boolean" }, "bodyHtml": { "type": "string" }, "sha": { "type": "string" } } } } } } }, "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BlogCmsController.getArticle" } }, "/blog-cms/articles": { "get": { "x-controller-name": "BlogCmsController", "x-operation-name": "listArticles", "tags": [ "BlogCmsController" ], "responses": { "200": { "description": "All blog articles (drafts and published), frontmatter only", "content": { "application/json": { "schema": { "type": "object", "properties": { "articles": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "date": { "type": "string" }, "author": { "type": "string" }, "published": { "type": "boolean" }, "invalid": { "type": "boolean" }, "error": { "type": "string" } } } } } } } } } }, "operationId": "BlogCmsController.listArticles" } }, "/blog-cms/can-manage": { "get": { "x-controller-name": "BlogCmsController", "x-operation-name": "canManage", "tags": [ "BlogCmsController" ], "responses": { "200": { "description": "Whether the caller may manage blog content", "content": { "application/json": { "schema": { "type": "object", "properties": { "canManageBlog": { "type": "boolean" } } } } } } }, "operationId": "BlogCmsController.canManage" } }, "/blog-cms/topics": { "put": { "x-controller-name": "BlogCmsController", "x-operation-name": "setTopics", "tags": [ "BlogCmsController" ], "responses": { "200": { "description": "The saved queue, its new blob sha, and the commit sha", "content": { "application/json": { "schema": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" } }, "sha": { "type": "string" }, "commitSha": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "topics" ], "properties": { "topics": { "type": "array", "items": { "type": "string" } }, "expectedSha": { "type": "string" } } } } } }, "operationId": "BlogCmsController.setTopics" }, "get": { "x-controller-name": "BlogCmsController", "x-operation-name": "getTopics", "tags": [ "BlogCmsController" ], "responses": { "200": { "description": "The topics queue and its git blob sha (null when unseeded)", "content": { "application/json": { "schema": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" } }, "sha": { "type": "string", "nullable": true } } } } } } }, "operationId": "BlogCmsController.getTopics" } }, "/board-assumptions": { "get": { "x-controller-name": "BoardTaskAssumptionsController", "x-operation-name": "list", "tags": [ "BoardTaskAssumptionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Board-wide assumptions, scoped to visible projects." } } } } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "BoardTaskAssumptionsController.list" } }, "/board-inline-files": { "post": { "x-controller-name": "BoardInlineFilesController", "x-operation-name": "upload", "tags": [ "BoardInlineFilesController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array" } } }, "description": "Stored board inline-image file metadata (one-element array)." } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "BoardInlineFilesController.upload" } }, "/board-projects/reorder": { "post": { "x-controller-name": "BoardProjectsController", "x-operation-name": "reorder", "tags": [ "BoardProjectsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Rewrite project positions within a section (the board-wide display order, same for everyone). SuperUser-only; the GET already sorts by position ASC so the new order loads by default." } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardProjectReorder" } } } }, "operationId": "BoardProjectsController.reorder" } }, "/board-projects/{id}/status-history": { "get": { "x-controller-name": "BoardProjectsController", "x-operation-name": "statusHistory", "tags": [ "BoardProjectsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Daily task-status buckets for a project (progress-over-time chart, #865). One entry per day, oldest→newest; pre-tracking days are flagged `reconstructed` (done vs a single open band)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "days", "in": "query", "schema": { "type": "number" } }, { "name": "tz", "in": "query", "schema": { "type": "string" } } ], "operationId": "BoardProjectsController.statusHistory" } }, "/board-projects/{id}": { "patch": { "x-controller-name": "BoardProjectsController", "x-operation-name": "updateById", "tags": [ "BoardProjectsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Reassign a project to another section, rename it, or describe/archive it" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardProjectUpdate" } } }, "x-parameter-index": 1 }, "operationId": "BoardProjectsController.updateById" }, "get": { "x-controller-name": "BoardProjectsController", "x-operation-name": "findById", "tags": [ "BoardProjectsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "One board project with topics + completion counts" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardProjectsController.findById" }, "delete": { "x-controller-name": "BoardProjectsController", "x-operation-name": "deleteById", "tags": [ "BoardProjectsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft-delete a board project. 400s if live tasks still reference it (move/delete them first)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardProjectsController.deleteById" } }, "/board-projects": { "post": { "x-controller-name": "BoardProjectsController", "x-operation-name": "create", "tags": [ "BoardProjectsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create a board project within a section, appended to the end (position = max+1 within the section)" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardProjectCreate" } } } }, "operationId": "BoardProjectsController.create" }, "get": { "x-controller-name": "BoardProjectsController", "x-operation-name": "find", "tags": [ "BoardProjectsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Board projects in the caller-visible sections (optionally one section), with topics + completion counts" } } } } }, "parameters": [ { "name": "sectionId", "in": "query", "schema": { "type": "number" } } ], "operationId": "BoardProjectsController.find" } }, "/board-questions": { "get": { "x-controller-name": "BoardTaskQuestionsController", "x-operation-name": "listVisibleQuestions", "tags": [ "BoardTaskQuestionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Cross-project question inventory for tooling/scan: open (or all) questions across the caller’s visible projects, each with its task context." } } } } }, "parameters": [ { "name": "open", "in": "query", "schema": { "type": "boolean" } }, { "name": "projectId", "in": "query", "schema": { "type": "number" } } ], "operationId": "BoardTaskQuestionsController.listVisibleQuestions" } }, "/board-search": { "get": { "x-controller-name": "BoardTasksController", "x-operation-name": "search", "tags": [ "BoardTasksController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Cross-board task search (board #1093): matches title, description, or #id across the caller-visible projects (optionally one section), newest first, each result carrying its project/section context for deep links." } } } } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "sectionId", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "BoardTasksController.search" } }, "/board-sections/admin": { "get": { "x-controller-name": "BoardSectionsController", "x-operation-name": "findAdmin", "tags": [ "BoardSectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "ALL non-deleted sections (no visibility filter — SuperUser only), with grants + projectCount attached" } } } } }, "operationId": "BoardSectionsController.findAdmin" } }, "/board-sections/reorder": { "post": { "x-controller-name": "BoardSectionsController", "x-operation-name": "reorder", "tags": [ "BoardSectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Rewrite section positions in the given order" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSectionReorder" } } } }, "operationId": "BoardSectionsController.reorder" } }, "/board-sections/{id}/grants": { "put": { "x-controller-name": "BoardSectionsController", "x-operation-name": "setGrants", "tags": [ "BoardSectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Replace the grant set for a board section" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSectionGrantsReplace" } } }, "x-parameter-index": 1 }, "operationId": "BoardSectionsController.setGrants" } }, "/board-sections/{id}/status-history": { "get": { "x-controller-name": "BoardSectionsController", "x-operation-name": "statusHistory", "tags": [ "BoardSectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Daily task-status buckets aggregated across a section's visible projects (progress-over-time chart, #865). One entry per day, oldest→newest; pre-tracking days are flagged `reconstructed`." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "days", "in": "query", "schema": { "type": "number" } }, { "name": "tz", "in": "query", "schema": { "type": "string" } } ], "operationId": "BoardSectionsController.statusHistory" } }, "/board-sections/{id}": { "patch": { "x-controller-name": "BoardSectionsController", "x-operation-name": "updateById", "tags": [ "BoardSectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update a board section (rename, set/clear its picture, and/or its notes)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSectionUpdate" } } }, "x-parameter-index": 1 }, "operationId": "BoardSectionsController.updateById" }, "delete": { "x-controller-name": "BoardSectionsController", "x-operation-name": "deleteById", "tags": [ "BoardSectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft-delete a board section; 400s if live projects still reference it (move/delete them first)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardSectionsController.deleteById" } }, "/board-sections": { "post": { "x-controller-name": "BoardSectionsController", "x-operation-name": "create", "tags": [ "BoardSectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create a board section, appended to the end (position = max+1)" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSectionCreate" } } } }, "operationId": "BoardSectionsController.create" }, "get": { "x-controller-name": "BoardSectionsController", "x-operation-name": "find", "tags": [ "BoardSectionsController" ], "responses": { "200": { "description": "Board sections visible to the caller, ordered by position", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSection" } } } } } }, "operationId": "BoardSectionsController.find" } }, "/board-service-tokens/{id}/revoke": { "post": { "x-controller-name": "BoardServiceTokensController", "x-operation-name": "revoke", "tags": [ "BoardServiceTokensController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Revoke a board service token (super user only). Idempotent." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardServiceTokensController.revoke" } }, "/board-service-tokens": { "post": { "x-controller-name": "BoardServiceTokensController", "x-operation-name": "mint", "tags": [ "BoardServiceTokensController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Mint a board service token (super user only). The plaintext token is returned ONCE here and never again — store it now." } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBoardServiceToken" } } } }, "operationId": "BoardServiceTokensController.mint" }, "get": { "x-controller-name": "BoardServiceTokensController", "x-operation-name": "list", "tags": [ "BoardServiceTokensController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "List board service tokens (super user only). Metadata only — never the token hash or plaintext." } } } } }, "operationId": "BoardServiceTokensController.list" } }, "/board-status-history": { "get": { "x-controller-name": "BoardSectionsController", "x-operation-name": "boardStatusHistory", "tags": [ "BoardSectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Daily task-status buckets aggregated across every project in the caller's visible sections (the /board home progress-over-time chart, #946). One entry per day, oldest→newest; pre-tracking days are flagged `reconstructed`." } } } } }, "parameters": [ { "name": "days", "in": "query", "schema": { "type": "number" } }, { "name": "tz", "in": "query", "schema": { "type": "string" } } ], "operationId": "BoardSectionsController.boardStatusHistory" } }, "/board-task-assumptions/{id}/accept": { "post": { "x-controller-name": "BoardTaskAssumptionsController", "x-operation-name": "accept", "tags": [ "BoardTaskAssumptionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Accept an assumption, promoting it to a business rule." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "actor", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "BoardTaskAssumptionsController.accept" } }, "/board-task-assumptions/{id}/reject": { "post": { "x-controller-name": "BoardTaskAssumptionsController", "x-operation-name": "reject", "tags": [ "BoardTaskAssumptionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Reject an assumption and open a revert ticket." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "actor", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "BoardTaskAssumptionsController.reject" } }, "/board-tasks/{id}/assumptions": { "post": { "x-controller-name": "BoardTaskAssumptionsController", "x-operation-name": "fileOrJoin", "tags": [ "BoardTaskAssumptionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "File a new assumption, or join an existing open one." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "actor", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "BoardTaskAssumptionsController.fileOrJoin" } }, "/board-tasks/{id}/attachments/{fileUploadId}": { "delete": { "x-controller-name": "BoardTaskAttachmentsController", "x-operation-name": "deleteById", "tags": [ "BoardTaskAttachmentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Remove an attachment (uploader or super user) — archives the row." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "fileUploadId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardTaskAttachmentsController.deleteById" } }, "/board-tasks/{id}/attachments": { "post": { "x-controller-name": "BoardTaskAttachmentsController", "x-operation-name": "create", "tags": [ "BoardTaskAttachmentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Link an uploaded file (from POST /files) to a board task as an attachment." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBoardTaskAttachment" } } }, "x-parameter-index": 1 }, "operationId": "BoardTaskAttachmentsController.create" } }, "/board-tasks/{id}/claim": { "post": { "x-controller-name": "BoardTasksController", "x-operation-name": "claim", "tags": [ "BoardTasksController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Claim a task for yourself (default) or for Claude (claimant: 'claude'). A claimed task is being actively worked, so todo moves to in_progress and the pause flag clears. 409 if already claimed." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTaskClaim" } } }, "required": false, "x-parameter-index": 1 }, "operationId": "BoardTasksController.claim" } }, "/board-tasks/{id}/comments/{commentId}": { "patch": { "x-controller-name": "BoardTaskCommentsController", "x-operation-name": "update", "tags": [ "BoardTaskCommentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Edit a comment (author or super user; local comments only)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "commentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTaskCommentPatch" } } }, "x-parameter-index": 2 }, "operationId": "BoardTaskCommentsController.update" }, "delete": { "x-controller-name": "BoardTaskCommentsController", "x-operation-name": "deleteById", "tags": [ "BoardTaskCommentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft-delete a comment (author or super user)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "commentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardTaskCommentsController.deleteById" } }, "/board-tasks/{id}/comments": { "post": { "x-controller-name": "BoardTaskCommentsController", "x-operation-name": "create", "tags": [ "BoardTaskCommentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Add a comment to a board task." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "actor", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBoardTaskComment" } } }, "x-parameter-index": 1 }, "operationId": "BoardTaskCommentsController.create" } }, "/board-tasks/{id}/move": { "post": { "x-controller-name": "BoardTasksController", "x-operation-name": "move", "tags": [ "BoardTasksController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Move a top-level task (and its subtasks) to another project. The now-invalid topic is cleared and the task is appended to the destination's top-level list." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTaskMove" } } }, "x-parameter-index": 1 }, "operationId": "BoardTasksController.move" } }, "/board-tasks/{id}/pause": { "post": { "x-controller-name": "BoardTasksController", "x-operation-name": "pause", "tags": [ "BoardTasksController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Toggle the local-only pause flag with an optional reason." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTaskPause" } } }, "x-parameter-index": 1 }, "operationId": "BoardTasksController.pause" } }, "/board-tasks/{id}/questions/{qid}/answer": { "post": { "x-controller-name": "BoardTaskQuestionsController", "x-operation-name": "answer", "tags": [ "BoardTaskQuestionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Answer a question (anyone with task visibility); may ungate." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "qid", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "actor", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTaskQuestionAnswer" } } }, "x-parameter-index": 2 }, "operationId": "BoardTaskQuestionsController.answer" } }, "/board-tasks/{id}/questions/{qid}/reopen": { "post": { "x-controller-name": "BoardTaskQuestionsController", "x-operation-name": "reopen", "tags": [ "BoardTaskQuestionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Clear a question’s answer (author, answerer, or super user); re-gates." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "qid", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardTaskQuestionsController.reopen" } }, "/board-tasks/{id}/questions/{qid}": { "patch": { "x-controller-name": "BoardTaskQuestionsController", "x-operation-name": "update", "tags": [ "BoardTaskQuestionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Edit an unanswered question (author or super user)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "qid", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTaskQuestionPatch" } } }, "x-parameter-index": 2 }, "operationId": "BoardTaskQuestionsController.update" }, "delete": { "x-controller-name": "BoardTaskQuestionsController", "x-operation-name": "deleteById", "tags": [ "BoardTaskQuestionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft-delete a question (author or super user); may ungate." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "qid", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardTaskQuestionsController.deleteById" } }, "/board-tasks/{id}/questions": { "post": { "x-controller-name": "BoardTaskQuestionsController", "x-operation-name": "create", "tags": [ "BoardTaskQuestionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Add a question to a board task (gates it to Needs More Info)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "actor", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBoardTaskQuestion" } } }, "x-parameter-index": 1 }, "operationId": "BoardTaskQuestionsController.create" } }, "/board-tasks/{id}/relations/{relationId}": { "delete": { "x-controller-name": "BoardTaskRelationsController", "x-operation-name": "deleteById", "tags": [ "BoardTaskRelationsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Unlink two board tasks (soft-delete the relation row)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "relationId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardTaskRelationsController.deleteById" } }, "/board-tasks/{id}/relations": { "post": { "x-controller-name": "BoardTaskRelationsController", "x-operation-name": "create", "tags": [ "BoardTaskRelationsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Link this board task to another one (one directed row)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "actor", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBoardTaskRelation" } } }, "x-parameter-index": 1 }, "operationId": "BoardTaskRelationsController.create" } }, "/board-tasks/{id}/release": { "post": { "x-controller-name": "BoardTasksController", "x-operation-name": "release", "tags": [ "BoardTasksController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Release a claimed task. in_progress reverts to todo (nobody is working it any more; done/blocked are deliberate states and stay). No-op if unclaimed." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "actor", "in": "query", "schema": { "type": "string" } } ], "operationId": "BoardTasksController.release" } }, "/board-tasks/{id}": { "patch": { "x-controller-name": "BoardTasksController", "x-operation-name": "update", "tags": [ "BoardTasksController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Edit a board task." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "actor", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTaskPatch" } } }, "x-parameter-index": 1 }, "operationId": "BoardTasksController.update" }, "get": { "x-controller-name": "BoardTasksController", "x-operation-name": "findById", "tags": [ "BoardTasksController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "One board task with subtasks, comments, attachments, and status-transition history" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardTasksController.findById" }, "delete": { "x-controller-name": "BoardTasksController", "x-operation-name": "deleteById", "tags": [ "BoardTasksController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft-delete a task (and its subtasks)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardTasksController.deleteById" } }, "/board-tasks": { "post": { "x-controller-name": "BoardTasksController", "x-operation-name": "create", "tags": [ "BoardTasksController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create a board task." } } } } }, "parameters": [ { "name": "actor", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBoardTask" } } } }, "operationId": "BoardTasksController.create" }, "get": { "x-controller-name": "BoardTasksController", "x-operation-name": "find", "tags": [ "BoardTasksController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Board tasks in caller-visible projects — the WHOLE tree by default. Pass ?includeSubtasks=false for top-level rows only, or ?parentTaskId to list one parent’s children." } } } } }, "parameters": [ { "name": "projectId", "in": "query", "schema": { "type": "number" } }, { "name": "topicId", "in": "query", "schema": { "type": "number" } }, { "name": "parentTaskId", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "assigneeUserId", "in": "query", "schema": { "type": "string" } }, { "name": "claimedBy", "in": "query", "schema": { "type": "string" } }, { "name": "paused", "in": "query", "schema": { "type": "boolean" } }, { "name": "mine", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeSubtasks", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "BoardTasksController.find" } }, "/board-topics/reorder": { "post": { "x-controller-name": "BoardTopicsController", "x-operation-name": "reorder", "tags": [ "BoardTopicsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Rewrite topic positions within a project." } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTopicReorder" } } } }, "operationId": "BoardTopicsController.reorder" } }, "/board-topics/{id}": { "patch": { "x-controller-name": "BoardTopicsController", "x-operation-name": "updateById", "tags": [ "BoardTopicsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Rename a board topic." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTopicUpdate" } } }, "x-parameter-index": 1 }, "operationId": "BoardTopicsController.updateById" }, "delete": { "x-controller-name": "BoardTopicsController", "x-operation-name": "deleteById", "tags": [ "BoardTopicsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft-delete a board topic; 400s if live tasks still reference it (move/complete them first)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoardTopicsController.deleteById" } }, "/board-topics": { "post": { "x-controller-name": "BoardTopicsController", "x-operation-name": "create", "tags": [ "BoardTopicsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create a board topic within a project, appended to the end (position = max+1 within the project)." } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTopicCreate" } } } }, "operationId": "BoardTopicsController.create" } }, "/bullet-point-mandate-groups/count": { "get": { "x-controller-name": "BulletPointMandateGroupController", "x-operation-name": "count", "tags": [ "BulletPointMandateGroupController" ], "responses": { "200": { "description": "BulletPointMandateGroup model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BulletPointMandateGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BulletPointMandateGroupController.count" } }, "/bullet-point-mandate-groups/{id}": { "put": { "x-controller-name": "BulletPointMandateGroupController", "x-operation-name": "replaceById", "tags": [ "BulletPointMandateGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BulletPointMandateGroup PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPointMandateGroup" } } }, "x-parameter-index": 1 }, "operationId": "BulletPointMandateGroupController.replaceById" }, "patch": { "x-controller-name": "BulletPointMandateGroupController", "x-operation-name": "updateById", "tags": [ "BulletPointMandateGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BulletPointMandateGroup PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPointMandateGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "BulletPointMandateGroupController.updateById" }, "get": { "x-controller-name": "BulletPointMandateGroupController", "x-operation-name": "findById", "tags": [ "BulletPointMandateGroupController" ], "responses": { "200": { "description": "BulletPointMandateGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPointMandateGroupWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPointMandateGroup.Filter" } } } } ], "operationId": "BulletPointMandateGroupController.findById" }, "delete": { "x-controller-name": "BulletPointMandateGroupController", "x-operation-name": "deleteById", "tags": [ "BulletPointMandateGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BulletPointMandateGroup DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BulletPointMandateGroupController.deleteById" } }, "/bullet-point-mandate-groups": { "post": { "x-controller-name": "BulletPointMandateGroupController", "x-operation-name": "create", "tags": [ "BulletPointMandateGroupController" ], "responses": { "200": { "description": "BulletPointMandateGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPointMandateGroup" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBulletPointMandateGroup" } } } }, "operationId": "BulletPointMandateGroupController.create" }, "patch": { "x-controller-name": "BulletPointMandateGroupController", "x-operation-name": "updateAll", "tags": [ "BulletPointMandateGroupController" ], "responses": { "200": { "description": "BulletPointMandateGroup PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BulletPointMandateGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPointMandateGroupPartial" } } } }, "operationId": "BulletPointMandateGroupController.updateAll" }, "get": { "x-controller-name": "BulletPointMandateGroupController", "x-operation-name": "find", "tags": [ "BulletPointMandateGroupController" ], "responses": { "200": { "description": "Array of BulletPointMandateGroup model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulletPointMandateGroupWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPointMandateGroup.Filter1" } } } } ], "operationId": "BulletPointMandateGroupController.find" } }, "/bullet-points/count": { "get": { "x-controller-name": "BulletPointsController", "x-operation-name": "count", "tags": [ "BulletPointsController" ], "responses": { "200": { "description": "BulletPoints model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BulletPoints.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BulletPointsController.count" } }, "/bullet-points/{id}": { "put": { "x-controller-name": "BulletPointsController", "x-operation-name": "replaceById", "tags": [ "BulletPointsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BulletPoints PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPoints" } } }, "x-parameter-index": 1 }, "operationId": "BulletPointsController.replaceById" }, "patch": { "x-controller-name": "BulletPointsController", "x-operation-name": "updateById", "tags": [ "BulletPointsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BulletPoints PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPointsPartial" } } }, "x-parameter-index": 1 }, "operationId": "BulletPointsController.updateById" }, "get": { "x-controller-name": "BulletPointsController", "x-operation-name": "findById", "tags": [ "BulletPointsController" ], "responses": { "200": { "description": "BulletPoints model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPointsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPoints.Filter" } } } } ], "operationId": "BulletPointsController.findById" }, "delete": { "x-controller-name": "BulletPointsController", "x-operation-name": "deleteById", "tags": [ "BulletPointsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BulletPoints DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BulletPointsController.deleteById" } }, "/bullet-points": { "post": { "x-controller-name": "BulletPointsController", "x-operation-name": "create", "tags": [ "BulletPointsController" ], "responses": { "200": { "description": "BulletPoints model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPoints" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBulletPoints" } } } }, "operationId": "BulletPointsController.create" }, "patch": { "x-controller-name": "BulletPointsController", "x-operation-name": "updateAll", "tags": [ "BulletPointsController" ], "responses": { "200": { "description": "BulletPoints PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BulletPoints.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPointsPartial" } } } }, "operationId": "BulletPointsController.updateAll" }, "get": { "x-controller-name": "BulletPointsController", "x-operation-name": "find", "tags": [ "BulletPointsController" ], "responses": { "200": { "description": "Array of BulletPoints model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulletPointsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletPoints.Filter1" } } } } ], "operationId": "BulletPointsController.find" } }, "/bulletpoint-groups/count": { "get": { "x-controller-name": "BulletPointGroupsController", "x-operation-name": "count", "tags": [ "BulletPointGroupsController" ], "responses": { "200": { "description": "BulletpointGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BulletpointGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BulletPointGroupsController.count" } }, "/bulletpoint-groups/{id}": { "put": { "x-controller-name": "BulletPointGroupsController", "x-operation-name": "replaceById", "tags": [ "BulletPointGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BulletpointGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletpointGroups" } } }, "x-parameter-index": 1 }, "operationId": "BulletPointGroupsController.replaceById" }, "patch": { "x-controller-name": "BulletPointGroupsController", "x-operation-name": "updateById", "tags": [ "BulletPointGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BulletpointGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletpointGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "BulletPointGroupsController.updateById" }, "get": { "x-controller-name": "BulletPointGroupsController", "x-operation-name": "findById", "tags": [ "BulletPointGroupsController" ], "responses": { "200": { "description": "BulletpointGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletpointGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletpointGroups.Filter" } } } } ], "operationId": "BulletPointGroupsController.findById" }, "delete": { "x-controller-name": "BulletPointGroupsController", "x-operation-name": "deleteById", "tags": [ "BulletPointGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BulletpointGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BulletPointGroupsController.deleteById" } }, "/bulletpoint-groups": { "post": { "x-controller-name": "BulletPointGroupsController", "x-operation-name": "create", "tags": [ "BulletPointGroupsController" ], "responses": { "200": { "description": "BulletpointGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletpointGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBulletpointGroups" } } } }, "operationId": "BulletPointGroupsController.create" }, "patch": { "x-controller-name": "BulletPointGroupsController", "x-operation-name": "updateAll", "tags": [ "BulletPointGroupsController" ], "responses": { "200": { "description": "BulletpointGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BulletpointGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletpointGroupsPartial" } } } }, "operationId": "BulletPointGroupsController.updateAll" }, "get": { "x-controller-name": "BulletPointGroupsController", "x-operation-name": "find", "tags": [ "BulletPointGroupsController" ], "responses": { "200": { "description": "Array of BulletpointGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulletpointGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulletpointGroups.Filter1" } } } } ], "operationId": "BulletPointGroupsController.find" } }, "/business-products/count": { "get": { "x-controller-name": "BusinessProductController", "x-operation-name": "count", "tags": [ "BusinessProductController" ], "responses": { "200": { "description": "BusinessProduct model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessProduct.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BusinessProductController.count" } }, "/business-products/{id}/business-rule-groups": { "post": { "x-controller-name": "BusinessProductBusinessRuleGroupController", "x-operation-name": "create", "tags": [ "BusinessProductBusinessRuleGroupController" ], "responses": { "200": { "description": "create a BusinessRuleGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroup" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBusinessRuleGroupInBusinessProduct" } } }, "x-parameter-index": 1 }, "operationId": "BusinessProductBusinessRuleGroupController.create" }, "patch": { "x-controller-name": "BusinessProductBusinessRuleGroupController", "x-operation-name": "patch", "tags": [ "BusinessProductBusinessRuleGroupController" ], "responses": { "200": { "description": "BusinessProduct.BusinessRuleGroup PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "BusinessProductBusinessRuleGroupController.patch" }, "get": { "x-controller-name": "BusinessProductBusinessRuleGroupController", "x-operation-name": "find", "tags": [ "BusinessProductBusinessRuleGroupController" ], "responses": { "200": { "description": "Array of BusinessProduct has many BusinessRuleGroup through BusinessRuleGroupsPerProduct", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRuleGroup" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "BusinessProductBusinessRuleGroupController.find" }, "delete": { "x-controller-name": "BusinessProductBusinessRuleGroupController", "x-operation-name": "delete", "tags": [ "BusinessProductBusinessRuleGroupController" ], "responses": { "200": { "description": "BusinessProduct.BusinessRuleGroup DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BusinessProductBusinessRuleGroupController.delete" } }, "/business-products/{id}": { "put": { "x-controller-name": "BusinessProductController", "x-operation-name": "replaceById", "tags": [ "BusinessProductController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessProduct PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProduct" } } }, "x-parameter-index": 1 }, "operationId": "BusinessProductController.replaceById" }, "patch": { "x-controller-name": "BusinessProductController", "x-operation-name": "updateById", "tags": [ "BusinessProductController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessProduct PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProductPartial" } } }, "x-parameter-index": 1 }, "operationId": "BusinessProductController.updateById" }, "get": { "x-controller-name": "BusinessProductController", "x-operation-name": "findById", "tags": [ "BusinessProductController" ], "responses": { "200": { "description": "BusinessProduct model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProductWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProduct.Filter" } } } } ], "operationId": "BusinessProductController.findById" }, "delete": { "x-controller-name": "BusinessProductController", "x-operation-name": "deleteById", "tags": [ "BusinessProductController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessProduct DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BusinessProductController.deleteById" } }, "/business-products": { "post": { "x-controller-name": "BusinessProductController", "x-operation-name": "create", "tags": [ "BusinessProductController" ], "responses": { "200": { "description": "BusinessProduct model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProduct" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBusinessProduct" } } } }, "operationId": "BusinessProductController.create" }, "patch": { "x-controller-name": "BusinessProductController", "x-operation-name": "updateAll", "tags": [ "BusinessProductController" ], "responses": { "200": { "description": "BusinessProduct PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessProduct.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProductPartial" } } } }, "operationId": "BusinessProductController.updateAll" }, "get": { "x-controller-name": "BusinessProductController", "x-operation-name": "find", "tags": [ "BusinessProductController" ], "responses": { "200": { "description": "Array of BusinessProduct model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessProductWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProduct.Filter1" } } } } ], "operationId": "BusinessProductController.find" } }, "/business-rule-groups/count": { "get": { "x-controller-name": "BusinessRuleGroupController", "x-operation-name": "count", "tags": [ "BusinessRuleGroupController" ], "responses": { "200": { "description": "BusinessRuleGroup model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BusinessRuleGroupController.count" } }, "/business-rule-groups/{id}/business-rules": { "post": { "x-controller-name": "BusinessRuleGroupBusinessRuleController", "x-operation-name": "create", "tags": [ "BusinessRuleGroupBusinessRuleController" ], "responses": { "200": { "description": "create a BusinessRule model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRule" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBusinessRuleInBusinessRuleGroup" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRuleGroupBusinessRuleController.create" }, "patch": { "x-controller-name": "BusinessRuleGroupBusinessRuleController", "x-operation-name": "patch", "tags": [ "BusinessRuleGroupBusinessRuleController" ], "responses": { "200": { "description": "BusinessRuleGroup.BusinessRule PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRule.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRulePartial" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRuleGroupBusinessRuleController.patch" }, "get": { "x-controller-name": "BusinessRuleGroupBusinessRuleController", "x-operation-name": "find", "tags": [ "BusinessRuleGroupBusinessRuleController" ], "responses": { "200": { "description": "Array of BusinessRuleGroup has many BusinessRule through BusinessRulesPerGroup", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRule" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "BusinessRuleGroupBusinessRuleController.find" }, "delete": { "x-controller-name": "BusinessRuleGroupBusinessRuleController", "x-operation-name": "delete", "tags": [ "BusinessRuleGroupBusinessRuleController" ], "responses": { "200": { "description": "BusinessRuleGroup.BusinessRule DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRule.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BusinessRuleGroupBusinessRuleController.delete" } }, "/business-rule-groups/{id}": { "put": { "x-controller-name": "BusinessRuleGroupController", "x-operation-name": "replaceById", "tags": [ "BusinessRuleGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRuleGroup PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroup" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRuleGroupController.replaceById" }, "patch": { "x-controller-name": "BusinessRuleGroupController", "x-operation-name": "updateById", "tags": [ "BusinessRuleGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRuleGroup PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRuleGroupController.updateById" }, "get": { "x-controller-name": "BusinessRuleGroupController", "x-operation-name": "findById", "tags": [ "BusinessRuleGroupController" ], "responses": { "200": { "description": "BusinessRuleGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroup.Filter" } } } } ], "operationId": "BusinessRuleGroupController.findById" }, "delete": { "x-controller-name": "BusinessRuleGroupController", "x-operation-name": "deleteById", "tags": [ "BusinessRuleGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRuleGroup DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BusinessRuleGroupController.deleteById" } }, "/business-rule-groups": { "post": { "x-controller-name": "BusinessRuleGroupController", "x-operation-name": "create", "tags": [ "BusinessRuleGroupController" ], "responses": { "200": { "description": "BusinessRuleGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroup" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBusinessRuleGroup" } } } }, "operationId": "BusinessRuleGroupController.create" }, "patch": { "x-controller-name": "BusinessRuleGroupController", "x-operation-name": "updateAll", "tags": [ "BusinessRuleGroupController" ], "responses": { "200": { "description": "BusinessRuleGroup PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupPartial" } } } }, "operationId": "BusinessRuleGroupController.updateAll" }, "get": { "x-controller-name": "BusinessRuleGroupController", "x-operation-name": "find", "tags": [ "BusinessRuleGroupController" ], "responses": { "200": { "description": "Array of BusinessRuleGroup model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRuleGroupWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroup.Filter1" } } } } ], "operationId": "BusinessRuleGroupController.find" } }, "/business-rule-groups-per-products/count": { "get": { "x-controller-name": "BusinessRuleGroupsPerProductController", "x-operation-name": "count", "tags": [ "BusinessRuleGroupsPerProductController" ], "responses": { "200": { "description": "BusinessRuleGroupsPerProduct model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleGroupsPerProduct.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BusinessRuleGroupsPerProductController.count" } }, "/business-rule-groups-per-products/{id}": { "put": { "x-controller-name": "BusinessRuleGroupsPerProductController", "x-operation-name": "replaceById", "tags": [ "BusinessRuleGroupsPerProductController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRuleGroupsPerProduct PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupsPerProduct" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRuleGroupsPerProductController.replaceById" }, "patch": { "x-controller-name": "BusinessRuleGroupsPerProductController", "x-operation-name": "updateById", "tags": [ "BusinessRuleGroupsPerProductController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRuleGroupsPerProduct PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupsPerProductPartial" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRuleGroupsPerProductController.updateById" }, "get": { "x-controller-name": "BusinessRuleGroupsPerProductController", "x-operation-name": "findById", "tags": [ "BusinessRuleGroupsPerProductController" ], "responses": { "200": { "description": "BusinessRuleGroupsPerProduct model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupsPerProductWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupsPerProduct.Filter" } } } } ], "operationId": "BusinessRuleGroupsPerProductController.findById" }, "delete": { "x-controller-name": "BusinessRuleGroupsPerProductController", "x-operation-name": "deleteById", "tags": [ "BusinessRuleGroupsPerProductController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRuleGroupsPerProduct DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BusinessRuleGroupsPerProductController.deleteById" } }, "/business-rule-groups-per-products": { "post": { "x-controller-name": "BusinessRuleGroupsPerProductController", "x-operation-name": "create", "tags": [ "BusinessRuleGroupsPerProductController" ], "responses": { "200": { "description": "BusinessRuleGroupsPerProduct model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupsPerProduct" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBusinessRuleGroupsPerProduct" } } } }, "operationId": "BusinessRuleGroupsPerProductController.create" }, "patch": { "x-controller-name": "BusinessRuleGroupsPerProductController", "x-operation-name": "updateAll", "tags": [ "BusinessRuleGroupsPerProductController" ], "responses": { "200": { "description": "BusinessRuleGroupsPerProduct PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleGroupsPerProduct.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupsPerProductPartial" } } } }, "operationId": "BusinessRuleGroupsPerProductController.updateAll" }, "get": { "x-controller-name": "BusinessRuleGroupsPerProductController", "x-operation-name": "find", "tags": [ "BusinessRuleGroupsPerProductController" ], "responses": { "200": { "description": "Array of BusinessRuleGroupsPerProduct model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRuleGroupsPerProductWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupsPerProduct.Filter1" } } } } ], "operationId": "BusinessRuleGroupsPerProductController.find" } }, "/business-rule-types/count": { "get": { "x-controller-name": "BusinessRuleTypesController", "x-operation-name": "count", "tags": [ "BusinessRuleTypesController" ], "responses": { "200": { "description": "BusinessRuleType model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BusinessRuleTypesController.count" } }, "/business-rule-types/{id}": { "put": { "x-controller-name": "BusinessRuleTypesController", "x-operation-name": "replaceById", "tags": [ "BusinessRuleTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRuleType PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleType" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRuleTypesController.replaceById" }, "patch": { "x-controller-name": "BusinessRuleTypesController", "x-operation-name": "updateById", "tags": [ "BusinessRuleTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRuleType PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleTypePartial" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRuleTypesController.updateById" }, "get": { "x-controller-name": "BusinessRuleTypesController", "x-operation-name": "findById", "tags": [ "BusinessRuleTypesController" ], "responses": { "200": { "description": "BusinessRuleType model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleTypeWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleType.Filter" } } } } ], "operationId": "BusinessRuleTypesController.findById" }, "delete": { "x-controller-name": "BusinessRuleTypesController", "x-operation-name": "deleteById", "tags": [ "BusinessRuleTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRuleType DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BusinessRuleTypesController.deleteById" } }, "/business-rule-types": { "post": { "x-controller-name": "BusinessRuleTypesController", "x-operation-name": "create", "tags": [ "BusinessRuleTypesController" ], "responses": { "200": { "description": "BusinessRuleType model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleType" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBusinessRuleType" } } } }, "operationId": "BusinessRuleTypesController.create" }, "patch": { "x-controller-name": "BusinessRuleTypesController", "x-operation-name": "updateAll", "tags": [ "BusinessRuleTypesController" ], "responses": { "200": { "description": "BusinessRuleType PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleTypePartial" } } } }, "operationId": "BusinessRuleTypesController.updateAll" }, "get": { "x-controller-name": "BusinessRuleTypesController", "x-operation-name": "find", "tags": [ "BusinessRuleTypesController" ], "responses": { "200": { "description": "Array of BusinessRuleType model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRuleTypeWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleType.Filter1" } } } } ], "operationId": "BusinessRuleTypesController.find" } }, "/business-rules/count": { "get": { "x-controller-name": "BusinessRuleController", "x-operation-name": "count", "tags": [ "BusinessRuleController" ], "responses": { "200": { "description": "BusinessRule model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRule.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BusinessRuleController.count" } }, "/business-rules/{id}": { "put": { "x-controller-name": "BusinessRuleController", "x-operation-name": "replaceById", "tags": [ "BusinessRuleController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRule PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRule" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRuleController.replaceById" }, "patch": { "x-controller-name": "BusinessRuleController", "x-operation-name": "updateById", "tags": [ "BusinessRuleController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRule PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRulePartial" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRuleController.updateById" }, "get": { "x-controller-name": "BusinessRuleController", "x-operation-name": "findById", "tags": [ "BusinessRuleController" ], "responses": { "200": { "description": "BusinessRule model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRule.Filter" } } } } ], "operationId": "BusinessRuleController.findById" }, "delete": { "x-controller-name": "BusinessRuleController", "x-operation-name": "deleteById", "tags": [ "BusinessRuleController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRule DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BusinessRuleController.deleteById" } }, "/business-rules": { "post": { "x-controller-name": "BusinessRuleController", "x-operation-name": "create", "tags": [ "BusinessRuleController" ], "responses": { "200": { "description": "BusinessRule model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRule" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBusinessRule" } } } }, "operationId": "BusinessRuleController.create" }, "patch": { "x-controller-name": "BusinessRuleController", "x-operation-name": "updateAll", "tags": [ "BusinessRuleController" ], "responses": { "200": { "description": "BusinessRule PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRule.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRulePartial" } } } }, "operationId": "BusinessRuleController.updateAll" }, "get": { "x-controller-name": "BusinessRuleController", "x-operation-name": "find", "tags": [ "BusinessRuleController" ], "responses": { "200": { "description": "Array of BusinessRule model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRuleWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRule.Filter1" } } } } ], "operationId": "BusinessRuleController.find" } }, "/business-rules-per-groups/count": { "get": { "x-controller-name": "BusinessRulesPerGroupController", "x-operation-name": "count", "tags": [ "BusinessRulesPerGroupController" ], "responses": { "200": { "description": "BusinessRulesPerGroup model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRulesPerGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BusinessRulesPerGroupController.count" } }, "/business-rules-per-groups/{id}": { "put": { "x-controller-name": "BusinessRulesPerGroupController", "x-operation-name": "replaceById", "tags": [ "BusinessRulesPerGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRulesPerGroup PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRulesPerGroup" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRulesPerGroupController.replaceById" }, "patch": { "x-controller-name": "BusinessRulesPerGroupController", "x-operation-name": "updateById", "tags": [ "BusinessRulesPerGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRulesPerGroup PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRulesPerGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "BusinessRulesPerGroupController.updateById" }, "get": { "x-controller-name": "BusinessRulesPerGroupController", "x-operation-name": "findById", "tags": [ "BusinessRulesPerGroupController" ], "responses": { "200": { "description": "BusinessRulesPerGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRulesPerGroupWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRulesPerGroup.Filter" } } } } ], "operationId": "BusinessRulesPerGroupController.findById" }, "delete": { "x-controller-name": "BusinessRulesPerGroupController", "x-operation-name": "deleteById", "tags": [ "BusinessRulesPerGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BusinessRulesPerGroup DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BusinessRulesPerGroupController.deleteById" } }, "/business-rules-per-groups": { "post": { "x-controller-name": "BusinessRulesPerGroupController", "x-operation-name": "create", "tags": [ "BusinessRulesPerGroupController" ], "responses": { "200": { "description": "BusinessRulesPerGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRulesPerGroup" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBusinessRulesPerGroup" } } } }, "operationId": "BusinessRulesPerGroupController.create" }, "patch": { "x-controller-name": "BusinessRulesPerGroupController", "x-operation-name": "updateAll", "tags": [ "BusinessRulesPerGroupController" ], "responses": { "200": { "description": "BusinessRulesPerGroup PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRulesPerGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRulesPerGroupPartial" } } } }, "operationId": "BusinessRulesPerGroupController.updateAll" }, "get": { "x-controller-name": "BusinessRulesPerGroupController", "x-operation-name": "find", "tags": [ "BusinessRulesPerGroupController" ], "responses": { "200": { "description": "Array of BusinessRulesPerGroup model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRulesPerGroupWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRulesPerGroup.Filter1" } } } } ], "operationId": "BusinessRulesPerGroupController.find" } }, "/cal-event-types/count": { "get": { "x-controller-name": "CalEventTypeController", "x-operation-name": "count", "tags": [ "CalEventTypeController" ], "responses": { "200": { "description": "CalEventType model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CalEventType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CalEventTypeController.count" } }, "/cal-event-types/{key}/bookings": { "post": { "x-controller-name": "CalEventTypeController", "x-operation-name": "createBooking", "tags": [ "CalEventTypeController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Created Cal.com booking" } } } } }, "parameters": [ { "name": "key", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "start", "attendee" ], "properties": { "start": { "type": "string", "description": "ISO 8601 UTC" }, "attendee": { "type": "object", "required": [ "name", "timeZone" ], "properties": { "name": { "type": "string" }, "timeZone": { "type": "string" }, "email": { "type": "string" } } }, "guests": { "type": "array", "items": { "type": "string" }, "maxItems": 50, "description": "Optional guest email addresses (max 10 after de-duplication)" }, "metadata": { "type": "object" } } } } }, "x-parameter-index": 1 }, "operationId": "CalEventTypeController.createBooking" } }, "/cal-event-types/{key}/slots": { "get": { "x-controller-name": "CalEventTypeController", "x-operation-name": "getSlots", "tags": [ "CalEventTypeController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Available Cal.com slots for this event type, grouped by date" } } } } }, "parameters": [ { "name": "key", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "start", "in": "query", "schema": { "type": "string" } }, { "name": "end", "in": "query", "schema": { "type": "string" } }, { "name": "timeZone", "in": "query", "schema": { "type": "string" } } ], "operationId": "CalEventTypeController.getSlots" } }, "/cal-event-types/{id}": { "put": { "x-controller-name": "CalEventTypeController", "x-operation-name": "replaceById", "tags": [ "CalEventTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CalEventType PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalEventType" } } }, "x-parameter-index": 1 }, "operationId": "CalEventTypeController.replaceById" }, "patch": { "x-controller-name": "CalEventTypeController", "x-operation-name": "updateById", "tags": [ "CalEventTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CalEventType PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalEventTypePartial" } } }, "x-parameter-index": 1 }, "operationId": "CalEventTypeController.updateById" }, "get": { "x-controller-name": "CalEventTypeController", "x-operation-name": "findById", "tags": [ "CalEventTypeController" ], "responses": { "200": { "description": "CalEventType model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalEventTypeWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalEventType.Filter" } } } } ], "operationId": "CalEventTypeController.findById" }, "delete": { "x-controller-name": "CalEventTypeController", "x-operation-name": "deleteById", "tags": [ "CalEventTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CalEventType DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CalEventTypeController.deleteById" } }, "/cal-event-types": { "post": { "x-controller-name": "CalEventTypeController", "x-operation-name": "create", "tags": [ "CalEventTypeController" ], "responses": { "200": { "description": "CalEventType model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalEventType" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCalEventType" } } } }, "operationId": "CalEventTypeController.create" }, "patch": { "x-controller-name": "CalEventTypeController", "x-operation-name": "updateAll", "tags": [ "CalEventTypeController" ], "responses": { "200": { "description": "CalEventType PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CalEventType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalEventTypePartial" } } } }, "operationId": "CalEventTypeController.updateAll" }, "get": { "x-controller-name": "CalEventTypeController", "x-operation-name": "find", "tags": [ "CalEventTypeController" ], "responses": { "200": { "description": "Array of CalEventType model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalEventTypeWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalEventType.Filter1" } } } } ], "operationId": "CalEventTypeController.find" } }, "/campaigns/count": { "get": { "x-controller-name": "CampaignsController", "x-operation-name": "count", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Campaign count, scoped like /campaigns", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Campaign.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CampaignsController.count" } }, "/campaigns/preview": { "post": { "x-controller-name": "CampaignsController", "x-operation-name": "preview", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Rendered subject/body + attachment metadata for the wizard", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewCampaign" } } } }, "operationId": "CampaignsController.preview" } }, "/campaigns/step-conditions": { "get": { "x-controller-name": "CampaignStepsController", "x-operation-name": "stepConditions", "tags": [ "CampaignStepsController" ], "responses": { "200": { "description": "Drip-condition availability for the step editor", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "CampaignStepsController.stepConditions" } }, "/campaigns/test-send": { "post": { "x-controller-name": "CampaignsController", "x-operation-name": "testSend", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Sends the rendered campaign email to the caller, marked [TEST]", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSendCampaign" } } } }, "operationId": "CampaignsController.testSend" } }, "/campaigns/{companyId}/appointments": { "get": { "x-controller-name": "CampaignsController", "x-operation-name": "recipientAppointments", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Appointments booked by a partner org's campaign recipients (#1318)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.recipientAppointments" } }, "/campaigns/{companyId}/converted-leads": { "get": { "x-controller-name": "CampaignsController", "x-operation-name": "convertedLeads", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "A partner org's converted leads with per-life rate, lives, owed/paid (#1475)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.convertedLeads" } }, "/campaigns/{id}/launch": { "post": { "x-controller-name": "CampaignsController", "x-operation-name": "launch", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "The launched campaign (status sending) + recipient count", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.launch" } }, "/campaigns/{id}/pause": { "post": { "x-controller-name": "CampaignsController", "x-operation-name": "pause", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "The paused campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.pause" } }, "/campaigns/{id}/replies": { "get": { "x-controller-name": "CampaignsController", "x-operation-name": "findReplies", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Inbound replies for one campaign, newest first, prospect embedded; bounded at 200 rows with the true total echoed", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.findReplies" } }, "/campaigns/{id}/resume": { "post": { "x-controller-name": "CampaignsController", "x-operation-name": "resume", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "The resumed campaign (status sending; self-corrects to sent)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.resume" } }, "/campaigns/{id}/sends": { "get": { "x-controller-name": "CampaignsController", "x-operation-name": "findSends", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Send rows for one campaign, prospect embedded, id order; ?engagement= narrows to one dashboard drill-down dimension", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "engagement", "in": "query", "schema": { "type": "string" } } ], "operationId": "CampaignsController.findSends" } }, "/campaigns/{id}/stats": { "get": { "x-controller-name": "CampaignsController", "x-operation-name": "stats", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Aggregate per-campaign send/engagement counts + sender capability flags", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.stats" } }, "/campaigns/{id}/steps/{stepId}": { "patch": { "x-controller-name": "CampaignStepsController", "x-operation-name": "updateStep", "tags": [ "CampaignStepsController" ], "responses": { "200": { "description": "Update a drip step on a DRAFT campaign (409 once launched)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStep" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "stepId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCampaignStep" } } }, "x-parameter-index": 2 }, "operationId": "CampaignStepsController.updateStep" }, "delete": { "x-controller-name": "CampaignStepsController", "x-operation-name": "deleteStep", "tags": [ "CampaignStepsController" ], "responses": { "200": { "description": "Delete a drip step on a DRAFT campaign; remaining steps renumber 1..n", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "stepId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignStepsController.deleteStep" } }, "/campaigns/{id}/steps": { "post": { "x-controller-name": "CampaignStepsController", "x-operation-name": "createStep", "tags": [ "CampaignStepsController" ], "responses": { "200": { "description": "Create a drip step on a DRAFT campaign (409 once launched)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStep" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCampaignStep" } } }, "x-parameter-index": 1 }, "operationId": "CampaignStepsController.createStep" }, "get": { "x-controller-name": "CampaignStepsController", "x-operation-name": "findSteps", "tags": [ "CampaignStepsController" ], "responses": { "200": { "description": "One campaign's drip steps, stepOrder ASC (scoped like /campaigns/{id})", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignStep" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignStepsController.findSteps" } }, "/campaigns/{id}/stop": { "post": { "x-controller-name": "CampaignsController", "x-operation-name": "stop", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "The stopped campaign + how many queued sends were cancelled", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.stop" } }, "/campaigns/{id}/timeseries": { "get": { "x-controller-name": "CampaignsController", "x-operation-name": "timeseries", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Daily engagement counts per dimension (gap-filled), for sparklines", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.timeseries" } }, "/campaigns/{id}/undrain": { "post": { "x-controller-name": "CampaignsController", "x-operation-name": "undrain", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "The campaign with drainedAt cleared (next sweep re-evaluates)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.undrain" } }, "/campaigns/{id}": { "patch": { "x-controller-name": "CampaignsController", "x-operation-name": "update", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Update a DRAFT campaign's details (name/template/recipients/throttle)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCampaignDraft" } } }, "x-parameter-index": 1 }, "operationId": "CampaignsController.update" }, "get": { "x-controller-name": "CampaignsController", "x-operation-name": "findById", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "One campaign (404 when missing or out of the caller scope)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.findById" } }, "/campaigns": { "post": { "x-controller-name": "CampaignsController", "x-operation-name": "create", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Create a DRAFT campaign (nothing sends until launch)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCampaign" } } } }, "operationId": "CampaignsController.create" }, "get": { "x-controller-name": "CampaignsController", "x-operation-name": "find", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Campaigns visible to the caller (scoped to their companies)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign.Filter" } } } } ], "operationId": "CampaignsController.find" } }, "/census-employees/{id}": { "patch": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "correctCensusEmployeeEmail", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "The applied correction and what the account sync did with it", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "additionalProperties": false, "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 254 } } } } }, "required": true, "x-parameter-index": 1 }, "operationId": "S125AnalyzerController.correctCensusEmployeeEmail" } }, "/census-imports/{id}/analysis-runs": { "post": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "runAnalysis", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The persisted analysis run and its full report" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "S125AnalyzerController.runAnalysis" } }, "/census-imports/{importId}/employees/{employeeId}": { "patch": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "correctCensusRow", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "The census import with its recomputed error report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CensusImport" } } } } }, "parameters": [ { "name": "importId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "employeeId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "externalId": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": false }, "lastName": { "type": "string", "nullable": false }, "ssn": { "type": "string", "nullable": false }, "subscriberId": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": false }, "employeeContributionMajorMedicalTotalPp": { "type": "number", "nullable": false }, "contribution401kTotalPp": { "type": "number", "nullable": false }, "additionalPretaxDeductionsTotalPp": { "type": "number", "nullable": false }, "postTaxDeductionsTotalPp": { "type": "number", "nullable": false }, "paySchedule": { "type": "string", "nullable": false }, "federalMaritalFilingStatus": { "type": "string", "nullable": false }, "stateMaritalFilingStatus": { "type": "string", "nullable": true }, "stateEmployeeFilesIn": { "type": "string", "nullable": false }, "stateOfResidence": { "type": "string", "nullable": true }, "stateExemptionsClaimed": { "type": "number", "nullable": true }, "stateDependentExemptionsClaimed": { "type": "number", "nullable": true }, "withholdingRatePercent": { "type": "number", "nullable": true }, "exemptionAmountClaimed": { "type": "number", "nullable": true }, "spouseWorks": { "type": "boolean", "nullable": true }, "countyOfResidence": { "type": "string", "nullable": true }, "dob": { "type": "string", "nullable": false, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "gender": { "type": "string", "nullable": false }, "hireDate": { "type": "string", "nullable": false, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "homePhone": { "type": "string", "nullable": true }, "mobilePhone": { "type": "string", "nullable": true }, "effectiveDate": { "type": "string", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } } }, "required": true, "x-parameter-index": 2 }, "operationId": "S125AnalyzerController.correctCensusRow" } }, "/census-imports/{id}/exports/missing-contact-info": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "downloadMissingContactInfoExport", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "S125AnalyzerController.downloadMissingContactInfoExport" } }, "/census-imports/{importId}/missing-info-link": { "post": { "x-controller-name": "MagicLinkController", "x-operation-name": "mintCensusMissingInfoLink", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "The minted census missing-info completion link", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "importId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MagicLinkController.mintCensusMissingInfoLink" } }, "/census-imports/{id}/original-file": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "downloadOriginalFile", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "S125AnalyzerController.downloadOriginalFile" } }, "/census-imports/{id}/provision-accounts": { "post": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "provisionAccounts", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-status provisioning summary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "S125AnalyzerController.provisionAccounts" } }, "/census-imports/{id}": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "getCensusImport", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "A single census import", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CensusImport" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "S125AnalyzerController.getCensusImport" } }, "/census-missing-info/{code}": { "post": { "x-controller-name": "MagicLinkController", "x-operation-name": "submitCensusMissingInfo", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "The rebuilt missing-info report after the submission", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "MagicLinkController.submitCensusMissingInfo" }, "get": { "x-controller-name": "MagicLinkController", "x-operation-name": "getCensusMissingInfo", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "The employer completion form for a census missing-info link", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MagicLinkController.getCensusMissingInfo" } }, "/census-state-filing-status-options": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "getCensusStateFilingStatusOptions", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "Per-state filing-status options for the census-correction editor", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "S125AnalyzerController.getCensusStateFilingStatusOptions" } }, "/challenges/mine": { "get": { "x-controller-name": "ChallengesController", "x-operation-name": "mine", "tags": [ "ChallengesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The caller's active challenges with progress" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "ChallengesController.mine" } }, "/challenges/{id}": { "patch": { "x-controller-name": "ChallengeAdminController", "x-operation-name": "updateById", "tags": [ "ChallengeAdminController" ], "responses": { "200": { "description": "The updated challenge definition", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "eventType": { "type": "string" }, "targetCount": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "isActive": { "type": "boolean" } } } } }, "x-parameter-index": 1 }, "operationId": "ChallengeAdminController.updateById" }, "delete": { "x-controller-name": "ChallengeAdminController", "x-operation-name": "deleteById", "tags": [ "ChallengeAdminController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Challenge DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ChallengeAdminController.deleteById" } }, "/cities/count": { "get": { "x-controller-name": "CitiesController", "x-operation-name": "count", "tags": [ "CitiesController" ], "responses": { "200": { "description": "Cities model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Cities.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CitiesController.count" } }, "/cities/{id}": { "put": { "x-controller-name": "CitiesController", "x-operation-name": "replaceById", "tags": [ "CitiesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Cities PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cities" } } }, "x-parameter-index": 1 }, "operationId": "CitiesController.replaceById" }, "patch": { "x-controller-name": "CitiesController", "x-operation-name": "updateById", "tags": [ "CitiesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Cities PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CitiesPartial" } } }, "x-parameter-index": 1 }, "operationId": "CitiesController.updateById" }, "get": { "x-controller-name": "CitiesController", "x-operation-name": "findById", "tags": [ "CitiesController" ], "responses": { "200": { "description": "Cities model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CitiesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cities.Filter" } } } } ], "operationId": "CitiesController.findById" }, "delete": { "x-controller-name": "CitiesController", "x-operation-name": "deleteById", "tags": [ "CitiesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Cities DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CitiesController.deleteById" } }, "/cities": { "post": { "x-controller-name": "CitiesController", "x-operation-name": "create", "tags": [ "CitiesController" ], "responses": { "200": { "description": "Cities model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cities" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCities" } } } }, "operationId": "CitiesController.create" }, "patch": { "x-controller-name": "CitiesController", "x-operation-name": "updateAll", "tags": [ "CitiesController" ], "responses": { "200": { "description": "Cities PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Cities.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CitiesPartial" } } } }, "operationId": "CitiesController.updateAll" }, "get": { "x-controller-name": "CitiesController", "x-operation-name": "find", "tags": [ "CitiesController" ], "responses": { "200": { "description": "Array of Cities model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CitiesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cities.Filter1" } } } } ], "operationId": "CitiesController.find" } }, "/clear-erc-users/{id}/companies": { "post": { "x-controller-name": "ClearErcUserCompanyController", "x-operation-name": "create", "tags": [ "ClearErcUserCompanyController" ], "responses": { "200": { "description": "create a Company model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCompanyInClearErcUser" } } }, "x-parameter-index": 1 }, "operationId": "ClearErcUserCompanyController.create" }, "patch": { "x-controller-name": "ClearErcUserCompanyController", "x-operation-name": "patch", "tags": [ "ClearErcUserCompanyController" ], "responses": { "200": { "description": "ClearErcUser.Company PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Company.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPartial" } } }, "x-parameter-index": 1 }, "operationId": "ClearErcUserCompanyController.patch" }, "get": { "x-controller-name": "ClearErcUserCompanyController", "x-operation-name": "find", "tags": [ "ClearErcUserCompanyController" ], "responses": { "200": { "description": "Array of ClearErcUser has many Company through UserCompany", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ClearErcUserCompanyController.find" }, "delete": { "x-controller-name": "ClearErcUserCompanyController", "x-operation-name": "delete", "tags": [ "ClearErcUserCompanyController" ], "responses": { "200": { "description": "ClearErcUser.Company DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Company.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ClearErcUserCompanyController.delete" } }, "/clear-erc-users/{id}/role-groups": { "post": { "x-controller-name": "ClearErcUserRoleGroupsController", "x-operation-name": "create", "tags": [ "ClearErcUserRoleGroupsController" ], "responses": { "200": { "description": "create a RoleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroups" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRoleGroupsInClearErcUser" } } }, "x-parameter-index": 1 }, "operationId": "ClearErcUserRoleGroupsController.create" }, "patch": { "x-controller-name": "ClearErcUserRoleGroupsController", "x-operation-name": "patch", "tags": [ "ClearErcUserRoleGroupsController" ], "responses": { "200": { "description": "ClearErcUser.RoleGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "ClearErcUserRoleGroupsController.patch" }, "get": { "x-controller-name": "ClearErcUserRoleGroupsController", "x-operation-name": "find", "tags": [ "ClearErcUserRoleGroupsController" ], "responses": { "200": { "description": "Array of ClearErcUser has many RoleGroups through RoleGroupUsers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleGroups" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ClearErcUserRoleGroupsController.find" }, "delete": { "x-controller-name": "ClearErcUserRoleGroupsController", "x-operation-name": "delete", "tags": [ "ClearErcUserRoleGroupsController" ], "responses": { "200": { "description": "ClearErcUser.RoleGroups DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ClearErcUserRoleGroupsController.delete" } }, "/client-statuses/count": { "get": { "x-controller-name": "ClientStatusesController", "x-operation-name": "count", "tags": [ "ClientStatusesController" ], "responses": { "200": { "description": "ClientStatuses model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ClientStatuses.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ClientStatusesController.count" } }, "/client-statuses/{id}": { "put": { "x-controller-name": "ClientStatusesController", "x-operation-name": "replaceById", "tags": [ "ClientStatusesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ClientStatuses PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientStatuses" } } }, "x-parameter-index": 1 }, "operationId": "ClientStatusesController.replaceById" }, "patch": { "x-controller-name": "ClientStatusesController", "x-operation-name": "updateById", "tags": [ "ClientStatusesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ClientStatuses PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientStatusesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ClientStatusesController.updateById" }, "get": { "x-controller-name": "ClientStatusesController", "x-operation-name": "findById", "tags": [ "ClientStatusesController" ], "responses": { "200": { "description": "ClientStatuses model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientStatusesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientStatuses.Filter" } } } } ], "operationId": "ClientStatusesController.findById" }, "delete": { "x-controller-name": "ClientStatusesController", "x-operation-name": "deleteById", "tags": [ "ClientStatusesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ClientStatuses DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ClientStatusesController.deleteById" } }, "/client-statuses": { "post": { "x-controller-name": "ClientStatusesController", "x-operation-name": "create", "tags": [ "ClientStatusesController" ], "responses": { "200": { "description": "ClientStatuses model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientStatuses" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewClientStatuses" } } } }, "operationId": "ClientStatusesController.create" }, "patch": { "x-controller-name": "ClientStatusesController", "x-operation-name": "updateAll", "tags": [ "ClientStatusesController" ], "responses": { "200": { "description": "ClientStatuses PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ClientStatuses.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientStatusesPartial" } } } }, "operationId": "ClientStatusesController.updateAll" }, "get": { "x-controller-name": "ClientStatusesController", "x-operation-name": "find", "tags": [ "ClientStatusesController" ], "responses": { "200": { "description": "Array of ClientStatuses model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientStatusesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientStatuses.Filter1" } } } } ], "operationId": "ClientStatusesController.find" } }, "/closure-likelihood-entries/count": { "get": { "x-controller-name": "ClosureLikelihoodEntriesController", "x-operation-name": "count", "tags": [ "ClosureLikelihoodEntriesController" ], "responses": { "200": { "description": "ClosureLikelihoodEntries model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ClosureLikelihoodEntries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ClosureLikelihoodEntriesController.count" } }, "/closure-likelihood-entries/{id}": { "put": { "x-controller-name": "ClosureLikelihoodEntriesController", "x-operation-name": "replaceById", "tags": [ "ClosureLikelihoodEntriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ClosureLikelihoodEntries PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodEntries" } } }, "x-parameter-index": 1 }, "operationId": "ClosureLikelihoodEntriesController.replaceById" }, "patch": { "x-controller-name": "ClosureLikelihoodEntriesController", "x-operation-name": "updateById", "tags": [ "ClosureLikelihoodEntriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ClosureLikelihoodEntries PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodEntriesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ClosureLikelihoodEntriesController.updateById" }, "get": { "x-controller-name": "ClosureLikelihoodEntriesController", "x-operation-name": "findById", "tags": [ "ClosureLikelihoodEntriesController" ], "responses": { "200": { "description": "ClosureLikelihoodEntries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodEntriesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodEntries.Filter" } } } } ], "operationId": "ClosureLikelihoodEntriesController.findById" }, "delete": { "x-controller-name": "ClosureLikelihoodEntriesController", "x-operation-name": "deleteById", "tags": [ "ClosureLikelihoodEntriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ClosureLikelihoodEntries DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ClosureLikelihoodEntriesController.deleteById" } }, "/closure-likelihood-entries": { "post": { "x-controller-name": "ClosureLikelihoodEntriesController", "x-operation-name": "create", "tags": [ "ClosureLikelihoodEntriesController" ], "responses": { "200": { "description": "ClosureLikelihoodEntries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodEntries" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewClosureLikelihoodEntries" } } } }, "operationId": "ClosureLikelihoodEntriesController.create" }, "patch": { "x-controller-name": "ClosureLikelihoodEntriesController", "x-operation-name": "updateAll", "tags": [ "ClosureLikelihoodEntriesController" ], "responses": { "200": { "description": "ClosureLikelihoodEntries PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ClosureLikelihoodEntries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodEntriesPartial" } } } }, "operationId": "ClosureLikelihoodEntriesController.updateAll" }, "get": { "x-controller-name": "ClosureLikelihoodEntriesController", "x-operation-name": "find", "tags": [ "ClosureLikelihoodEntriesController" ], "responses": { "200": { "description": "Array of ClosureLikelihoodEntries model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClosureLikelihoodEntriesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodEntries.Filter1" } } } } ], "operationId": "ClosureLikelihoodEntriesController.find" } }, "/closure-likelihood-types/count": { "get": { "x-controller-name": "ClosureLikelihoodTypesController", "x-operation-name": "count", "tags": [ "ClosureLikelihoodTypesController" ], "responses": { "200": { "description": "ClosureLikelihoodTypes model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ClosureLikelihoodTypes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ClosureLikelihoodTypesController.count" } }, "/closure-likelihood-types/{id}": { "put": { "x-controller-name": "ClosureLikelihoodTypesController", "x-operation-name": "replaceById", "tags": [ "ClosureLikelihoodTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ClosureLikelihoodTypes PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodTypes" } } }, "x-parameter-index": 1 }, "operationId": "ClosureLikelihoodTypesController.replaceById" }, "patch": { "x-controller-name": "ClosureLikelihoodTypesController", "x-operation-name": "updateById", "tags": [ "ClosureLikelihoodTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ClosureLikelihoodTypes PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodTypesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ClosureLikelihoodTypesController.updateById" }, "get": { "x-controller-name": "ClosureLikelihoodTypesController", "x-operation-name": "findById", "tags": [ "ClosureLikelihoodTypesController" ], "responses": { "200": { "description": "ClosureLikelihoodTypes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodTypesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodTypes.Filter" } } } } ], "operationId": "ClosureLikelihoodTypesController.findById" }, "delete": { "x-controller-name": "ClosureLikelihoodTypesController", "x-operation-name": "deleteById", "tags": [ "ClosureLikelihoodTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ClosureLikelihoodTypes DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ClosureLikelihoodTypesController.deleteById" } }, "/closure-likelihood-types": { "post": { "x-controller-name": "ClosureLikelihoodTypesController", "x-operation-name": "create", "tags": [ "ClosureLikelihoodTypesController" ], "responses": { "200": { "description": "ClosureLikelihoodTypes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodTypes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewClosureLikelihoodTypes" } } } }, "operationId": "ClosureLikelihoodTypesController.create" }, "patch": { "x-controller-name": "ClosureLikelihoodTypesController", "x-operation-name": "updateAll", "tags": [ "ClosureLikelihoodTypesController" ], "responses": { "200": { "description": "ClosureLikelihoodTypes PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ClosureLikelihoodTypes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodTypesPartial" } } } }, "operationId": "ClosureLikelihoodTypesController.updateAll" }, "get": { "x-controller-name": "ClosureLikelihoodTypesController", "x-operation-name": "find", "tags": [ "ClosureLikelihoodTypesController" ], "responses": { "200": { "description": "Array of ClosureLikelihoodTypes model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClosureLikelihoodTypesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureLikelihoodTypes.Filter1" } } } } ], "operationId": "ClosureLikelihoodTypesController.find" } }, "/commission-changes/count": { "get": { "x-controller-name": "CommissionChangeController", "x-operation-name": "count", "tags": [ "CommissionChangeController" ], "responses": { "200": { "description": "CommissionChange model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CommissionChange.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CommissionChangeController.count" } }, "/commission-changes/{id}": { "put": { "x-controller-name": "CommissionChangeController", "x-operation-name": "replaceById", "tags": [ "CommissionChangeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CommissionChange PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommissionChange" } } }, "x-parameter-index": 1 }, "operationId": "CommissionChangeController.replaceById" }, "get": { "x-controller-name": "CommissionChangeController", "x-operation-name": "findById", "tags": [ "CommissionChangeController" ], "responses": { "200": { "description": "CommissionChange model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommissionChangeWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommissionChange.Filter" } } } } ], "operationId": "CommissionChangeController.findById" }, "delete": { "x-controller-name": "CommissionChangeController", "x-operation-name": "deleteById", "tags": [ "CommissionChangeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CommissionChange DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CommissionChangeController.deleteById" } }, "/commission-changes": { "post": { "x-controller-name": "CommissionChangeController", "x-operation-name": "create", "tags": [ "CommissionChangeController" ], "responses": { "200": { "description": "CommissionChange model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommissionChange" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCommissionChange" } } } }, "operationId": "CommissionChangeController.create" }, "patch": { "x-controller-name": "CommissionChangeController", "x-operation-name": "updateAll", "tags": [ "CommissionChangeController" ], "responses": { "200": { "description": "CommissionChange PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CommissionChange.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommissionChangePartial" } } } }, "operationId": "CommissionChangeController.updateAll" }, "get": { "x-controller-name": "CommissionChangeController", "x-operation-name": "find", "tags": [ "CommissionChangeController" ], "responses": { "200": { "description": "Array of CommissionChange model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommissionChangeWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommissionChange.Filter1" } } } } ], "operationId": "CommissionChangeController.find" } }, "/companies/-1": { "get": { "x-controller-name": "CompaniesController", "x-operation-name": "findByIdNegativeOne", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "Company model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.Filter" } } } } ], "operationId": "CompaniesController.findByIdNegativeOne" } }, "/companies/count": { "get": { "x-controller-name": "CompaniesController", "x-operation-name": "count", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "Company model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Company.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompaniesController.count" } }, "/companies/hedge-funds": { "get": { "x-controller-name": "CompaniesController", "x-operation-name": "findHedgeFunds", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "Array of Company model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.Filter1" } } } } ], "operationId": "CompaniesController.findHedgeFunds" } }, "/companies/pipeline-status": { "get": { "x-controller-name": "CompanyPipelineController", "x-operation-name": "listPipelineStatus", "tags": [ "CompanyPipelineController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-company pipeline status, paginated" } } } } }, "parameters": [ { "name": "stage", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } } ], "operationId": "CompanyPipelineController.listPipelineStatus" } }, "/companies/setup": { "post": { "x-controller-name": "CompaniesController", "x-operation-name": "setupCompany", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "Company model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "company": { "$ref": "#/components/schemas/Company", "definitions": { "Company": { "$ref": "#/components/schemas/Company" } } }, "owner": { "$ref": "#/components/schemas/ClearErcUser", "definitions": { "ClearErcUser": { "$ref": "#/components/schemas/ClearErcUser" } } }, "ownerPassword": { "type": "string" }, "ownerRoleId": { "type": "number" }, "isUnderAudit": { "type": "number" }, "ercAmount": { "type": "number" }, "commissionPercentage": { "type": "number" }, "w2Employees": { "type": "object", "properties": { "2020": { "type": "number" }, "2021": { "type": "number" }, "now": { "type": "number" } } }, "members": { "type": "array", "items": { "properties": { "user": { "$ref": "#/components/schemas/ClearErcUser", "definitions": { "ClearErcUser": { "$ref": "#/components/schemas/ClearErcUser" } } }, "userCompany": { "$ref": "#/components/schemas/UserCompany", "definitions": { "UserCompany": { "$ref": "#/components/schemas/UserCompany" } } } } } } } } } } }, "operationId": "CompaniesController.setupCompany" } }, "/companies/{companyId}/activate-employees": { "post": { "x-controller-name": "EmployeeActivationController", "x-operation-name": "activateEmployees", "tags": [ "EmployeeActivationController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-employee activation outcomes + summary" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "censusEmployeeIds" ], "properties": { "censusEmployeeIds": { "type": "array", "items": { "type": "number" } } } } } }, "x-parameter-index": 1 }, "operationId": "EmployeeActivationController.activateEmployees" } }, "/companies/{companyId}/alert-mutes/{alertTypeId}": { "delete": { "x-controller-name": "AlertCompanyMuteController", "x-operation-name": "delete", "tags": [ "AlertCompanyMuteController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Alert Company Mute DELETE success" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "alertTypeId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AlertCompanyMuteController.delete" } }, "/companies/{companyId}/alert-mutes": { "post": { "x-controller-name": "AlertCompanyMuteController", "x-operation-name": "create", "tags": [ "AlertCompanyMuteController" ], "responses": { "200": { "description": "Alert Company Mute model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertCompanyMute" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "alertTypeId" ], "properties": { "alertTypeId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "AlertCompanyMuteController.create" }, "get": { "x-controller-name": "AlertCompanyMuteController", "x-operation-name": "find", "tags": [ "AlertCompanyMuteController" ], "responses": { "200": { "description": "Alert types muted for this company", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertCompanyMute" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AlertCompanyMuteController.find" } }, "/companies/{companyId}/analysis-runs": { "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "listAnalysisRuns", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "Analysis runs for a company, newest first", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisRun" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "S125AnalyzerController.listAnalysisRuns" } }, "/companies/{id}/assign-mandates": { "post": { "x-controller-name": "CompaniesController", "x-operation-name": "assignMandates", "tags": [ "CompaniesController" ], "responses": { "204": { "description": "Company PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } }, "x-parameter-index": 1 }, "operationId": "CompaniesController.assignMandates" } }, "/companies/{id}/banking-details": { "get": { "x-controller-name": "CompaniesController", "x-operation-name": "findBankingDetails", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "The company's banking + EIN fields only", "content": { "application/json": { "schema": { "type": "object", "properties": { "routingNumber": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "accountHolderName": { "type": "string", "nullable": true }, "bankName": { "type": "string", "nullable": true }, "bankAddress": { "type": "string", "nullable": true }, "bankCity": { "type": "string", "nullable": true }, "bankState": { "type": "string", "nullable": true }, "bankZipCode": { "type": "string", "nullable": true }, "einNumber": { "type": "string", "nullable": true } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompaniesController.findBankingDetails" } }, "/companies/{companyId}/billing-config": { "put": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "putBillingConfig", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.putBillingConfig" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PerLifeBillingController.putBillingConfig" }, "get": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "getBillingConfig", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.getBillingConfig" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PerLifeBillingController.getBillingConfig" } }, "/companies/{companyId}/billing-rosters/import": { "post": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "importRoster", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.importRoster" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PerLifeBillingController.importRoster" } }, "/companies/{companyId}/billing-rosters/preview": { "post": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "preview", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.preview" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PerLifeBillingController.preview" } }, "/companies/{companyId}/billing-rosters": { "get": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "listRosters", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.listRosters" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "month", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerLifeBillingController.listRosters" } }, "/companies/{companyId}/census-imports": { "post": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "uploadCensus", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "The created census import (status complete or failed)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CensusImport" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "S125AnalyzerController.uploadCensus" }, "get": { "x-controller-name": "S125AnalyzerController", "x-operation-name": "listCensusImports", "tags": [ "S125AnalyzerController" ], "responses": { "200": { "description": "Census history for a company, newest first", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "S125AnalyzerController.listCensusImports" } }, "/companies/{companyId}/census-missing-info": { "post": { "x-controller-name": "EmployerCensusMissingInfoController", "x-operation-name": "submitForCompany", "tags": [ "EmployerCensusMissingInfoController" ], "responses": { "200": { "description": "The rebuilt missing-info result after the submission", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "EmployerCensusMissingInfoController.submitForCompany" }, "get": { "x-controller-name": "EmployerCensusMissingInfoController", "x-operation-name": "getForCompany", "tags": [ "EmployerCensusMissingInfoController" ], "responses": { "200": { "description": "The company's missing employee-info completion form", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployerCensusMissingInfoController.getForCompany" } }, "/companies/{companyId}/challenges": { "post": { "x-controller-name": "ChallengeAdminController", "x-operation-name": "create", "tags": [ "ChallengeAdminController" ], "responses": { "200": { "description": "The created challenge definition", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "eventType": { "type": "string" }, "targetCount": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "isActive": { "type": "boolean" } } } } }, "x-parameter-index": 1 }, "operationId": "ChallengeAdminController.create" }, "get": { "x-controller-name": "ChallengeAdminController", "x-operation-name": "findForCompany", "tags": [ "ChallengeAdminController" ], "responses": { "200": { "description": "The company's challenge definitions (active AND inactive)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ChallengeAdminController.findForCompany" } }, "/companies/{companyId}/checklist-items/{itemKey}": { "put": { "x-controller-name": "CompanyChecklistsController", "x-operation-name": "setItem", "tags": [ "CompanyChecklistsController" ], "responses": { "200": { "description": "Upserted checklist item state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyChecklistItem" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "itemKey", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "checked": { "type": "boolean" }, "assignedUserId": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 2 }, "operationId": "CompanyChecklistsController.setItem" } }, "/companies/{companyId}/checklist-items": { "get": { "x-controller-name": "CompanyChecklistsController", "x-operation-name": "findForCompany", "tags": [ "CompanyChecklistsController" ], "responses": { "200": { "description": "The company's manually-tracked checklist items (rows exist once toggled)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyChecklistItem" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyChecklistsController.findForCompany" } }, "/companies/{id}/clear-erc-users": { "post": { "x-controller-name": "CompanyClearErcUserController", "x-operation-name": "create", "tags": [ "CompanyClearErcUserController" ], "responses": { "200": { "description": "create a ClearErcUser model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUser" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewClearErcUserInCompany" } } }, "x-parameter-index": 1 }, "operationId": "CompanyClearErcUserController.create" }, "patch": { "x-controller-name": "CompanyClearErcUserController", "x-operation-name": "patch", "tags": [ "CompanyClearErcUserController" ], "responses": { "200": { "description": "Company.ClearErcUser PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ClearErcUser.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearErcUserPartial" } } }, "x-parameter-index": 1 }, "operationId": "CompanyClearErcUserController.patch" }, "get": { "x-controller-name": "CompanyClearErcUserController", "x-operation-name": "find", "tags": [ "CompanyClearErcUserController" ], "responses": { "200": { "description": "Array of Company has many ClearErcUser through UserCompany", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarshalledUser" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CompanyClearErcUserController.find" }, "delete": { "x-controller-name": "CompanyClearErcUserController", "x-operation-name": "delete", "tags": [ "CompanyClearErcUserController" ], "responses": { "200": { "description": "Company.ClearErcUser DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ClearErcUser.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyClearErcUserController.delete" } }, "/companies/{companyId}/client-timeline": { "get": { "x-controller-name": "ClientTimelineController", "x-operation-name": "clientTimeline", "tags": [ "ClientTimelineController" ], "responses": { "200": { "description": "The unified client timeline for a company, newest first.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "number" }, "kind": { "type": "string" }, "occurredAt": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "actor": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "companyId", "kind", "occurredAt", "title" ] } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "ClientTimelineController.clientTimeline" } }, "/companies/{companyId}/company-documents": { "get": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "listForCompany", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "Live documents for a company, newest first", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDocument" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyDocumentsController.listForCompany" } }, "/companies/{companyId}/company-emails": { "post": { "x-controller-name": "CompanyEmailsController", "x-operation-name": "create", "tags": [ "CompanyEmailsController" ], "responses": { "200": { "description": "Added company email", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyEmail" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" }, "label": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "CompanyEmailsController.create" }, "get": { "x-controller-name": "CompanyEmailsController", "x-operation-name": "listForCompany", "tags": [ "CompanyEmailsController" ], "responses": { "200": { "description": "Additional emails for a company, newest first", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyEmail" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyEmailsController.listForCompany" } }, "/companies/{companyId}/contact-replacements/email": { "post": { "x-controller-name": "CompanyContactReplacementController", "x-operation-name": "replaceEmail", "tags": [ "CompanyContactReplacementController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The recorded replacement" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "newEmail" ], "properties": { "userId": { "type": "string" }, "newEmail": { "type": "string" }, "note": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "CompanyContactReplacementController.replaceEmail" } }, "/companies/{companyId}/contact-replacements/person": { "post": { "x-controller-name": "CompanyContactReplacementController", "x-operation-name": "replacePerson", "tags": [ "CompanyContactReplacementController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The recorded replacement" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "replacedUserId", "email" ], "properties": { "replacedUserId": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "note": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "CompanyContactReplacementController.replacePerson" } }, "/companies/{companyId}/contact-replacements": { "get": { "x-controller-name": "CompanyContactReplacementController", "x-operation-name": "listReplacements", "tags": [ "CompanyContactReplacementController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Contact replacement history for the company" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyContactReplacementController.listReplacements" } }, "/companies/{companyId}/deal/lost": { "post": { "x-controller-name": "CompanyDealStateController", "x-operation-name": "markLost", "tags": [ "CompanyDealStateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The resulting deal state" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "reason" ], "properties": { "reason": { "type": "string", "enum": [ "ghosted", "choseCompetitor", "notEligible", "other" ] }, "note": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "CompanyDealStateController.markLost" } }, "/companies/{companyId}/deal/revive": { "post": { "x-controller-name": "CompanyDealStateController", "x-operation-name": "revive", "tags": [ "CompanyDealStateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The resulting deal state" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyDealStateController.revive" } }, "/companies/{companyId}/deal": { "get": { "x-controller-name": "CompanyDealStateController", "x-operation-name": "getDealState", "tags": [ "CompanyDealStateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Current deal state for the company" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyDealStateController.getDealState" } }, "/companies/{companyId}/decline-employees": { "post": { "x-controller-name": "EmployeeActivationController", "x-operation-name": "declineEmployees", "tags": [ "EmployeeActivationController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "How many census rows were updated" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "censusEmployeeIds", "declined" ], "properties": { "censusEmployeeIds": { "type": "array", "items": { "type": "number" } }, "declined": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "EmployeeActivationController.declineEmployees" } }, "/companies/{companyId}/document-invites": { "post": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "createInvite", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Created invite + its share link" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" }, "companyDocumentId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "CompanyDocumentsController.createInvite" }, "get": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "listInvites", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "All invites for a company, newest first" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyDocumentsController.listInvites" } }, "/companies/{companyId}/education-content": { "post": { "x-controller-name": "EducationContentAdminController", "x-operation-name": "create", "tags": [ "EducationContentAdminController" ], "responses": { "200": { "description": "The created education content row", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "kind": { "type": "string" }, "body": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "sortOrder": { "type": "number" }, "language": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean" }, "scheduledAt": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "EducationContentAdminController.create" }, "get": { "x-controller-name": "EducationContentAdminController", "x-operation-name": "findForCompany", "tags": [ "EducationContentAdminController" ], "responses": { "200": { "description": "The company's education content (published AND unpublished)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EducationContentAdminController.findForCompany" } }, "/companies/{companyId}/email-messages": { "get": { "x-controller-name": "EmailMessagesController", "x-operation-name": "findForCompany", "tags": [ "EmailMessagesController" ], "responses": { "200": { "description": "Return value of EmailMessagesController.findForCompany" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMessagesController.findForCompany" } }, "/companies/{companyId}/email-stats": { "get": { "x-controller-name": "EmailMessagesController", "x-operation-name": "findStatsForCompany", "tags": [ "EmailMessagesController" ], "responses": { "200": { "description": "Return value of EmailMessagesController.findStatsForCompany" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailMessagesController.findStatsForCompany" } }, "/companies/{companyId}/email-suppression": { "get": { "x-controller-name": "EmailSuppressionController", "x-operation-name": "findForCompany", "tags": [ "EmailSuppressionController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Suppressed addresses this company has mailed" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailSuppressionController.findForCompany" } }, "/companies/{companyId}/employee-activation-roster": { "get": { "x-controller-name": "EmployeeActivationController", "x-operation-name": "roster", "tags": [ "EmployeeActivationController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The company's census employees + activation state" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployeeActivationController.roster" } }, "/companies/{companyId}/employee-change-requests": { "get": { "x-controller-name": "EmployeeChangeRequestsController", "x-operation-name": "listForCompany", "tags": [ "EmployeeChangeRequestsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The company's change-request queue" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployeeChangeRequestsController.listForCompany" } }, "/companies/{companyId}/employee-comms/send": { "post": { "x-controller-name": "EmployeeCommsController", "x-operation-name": "send", "tags": [ "EmployeeCommsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-recipient send outcome" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "EmployeeCommsController.send" } }, "/companies/{companyId}/employee-comms/sends": { "get": { "x-controller-name": "EmployeeCommsController", "x-operation-name": "listSends", "tags": [ "EmployeeCommsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The company's employee-comms send record" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployeeCommsController.listSends" } }, "/companies/{companyId}/employee-comms/templates": { "get": { "x-controller-name": "EmployeeCommsController", "x-operation-name": "listTemplates", "tags": [ "EmployeeCommsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The company's employee-comms template library" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployeeCommsController.listTemplates" } }, "/companies/{companyId}/employee-documents": { "get": { "x-controller-name": "EmployeeDocumentsController", "x-operation-name": "listCompanyEmployeeDocuments", "tags": [ "EmployeeDocumentsController" ], "responses": { "200": { "description": "A company's per-employee documents, newest first", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "documentType", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmployeeDocumentsController.listCompanyEmployeeDocuments" } }, "/companies/{id}/employee-period-report": { "get": { "x-controller-name": "EmployeePeriodReportController", "x-operation-name": "findByCompany", "tags": [ "EmployeePeriodReportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-pay-period employee standing and counts for the company's recent pay periods" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "periods", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployeePeriodReportController.findByCompany" } }, "/companies/{companyId}/employer-documents/baa/start-signing": { "post": { "x-controller-name": "EmployerDashboardController", "x-operation-name": "startBaaSigning", "tags": [ "EmployerDashboardController" ], "responses": { "200": { "description": "A live documentSign link for the company BAA", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "signUrl": { "type": "string" } } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true } } } } }, "x-parameter-index": 1 }, "operationId": "EmployerDashboardController.startBaaSigning" } }, "/companies/{companyId}/employer-documents/msa/start-signing": { "post": { "x-controller-name": "EmployerDashboardController", "x-operation-name": "startMsaSigning", "tags": [ "EmployerDashboardController" ], "responses": { "200": { "description": "A live documentSign link for the company MSA", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "signUrl": { "type": "string" } } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true } } } } }, "x-parameter-index": 1 }, "operationId": "EmployerDashboardController.startMsaSigning" } }, "/companies/{companyId}/employer-documents": { "get": { "x-controller-name": "EmployerDashboardController", "x-operation-name": "getEmployerDocuments", "tags": [ "EmployerDashboardController" ], "responses": { "200": { "description": "The employer's own documents (v1: BAA sends), whitelisted to type/status/signUrl", "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "status": { "type": "string" }, "signUrl": { "type": "string", "nullable": true } } } } } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployerDashboardController.getEmployerDocuments" } }, "/companies/{companyId}/employer-group/summary": { "get": { "x-controller-name": "EmployerGroupSummaryController", "x-operation-name": "summary", "tags": [ "EmployerGroupSummaryController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The caller's entities in this company's employer group" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployerGroupSummaryController.summary" } }, "/companies/{companyId}/employer-group": { "get": { "x-controller-name": "EmployerGroupController", "x-operation-name": "findForCompany", "tags": [ "EmployerGroupController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The company's employer group, or null" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployerGroupController.findForCompany" } }, "/companies/{companyId}/employer-phase": { "get": { "x-controller-name": "EmployerPhaseController", "x-operation-name": "getPhase", "tags": [ "EmployerPhaseController" ], "responses": { "200": { "description": "The company's Employer Phase: override-or-derived, plus the signals", "content": { "application/json": { "schema": { "type": "object", "properties": { "phase": { "type": "string" }, "derivedPhase": { "type": "string" }, "override": { "type": "string", "nullable": true }, "signals": { "type": "object" } } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployerPhaseController.getPhase" } }, "/companies/{companyId}/employer-phase-override": { "patch": { "x-controller-name": "EmployerPhaseController", "x-operation-name": "setOverride", "tags": [ "EmployerPhaseController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Updated override; returns the recomputed phase" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "override" ], "properties": { "override": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "EmployerPhaseController.setOverride" } }, "/companies/{companyId}/expected-periods": { "get": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "expectedPeriods", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.expectedPeriods" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "month", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerLifeBillingController.expectedPeriods" } }, "/companies/{companyId}/hours-csv": { "post": { "x-controller-name": "EmployerHoursCsvController", "x-operation-name": "uploadHoursCsv", "tags": [ "EmployerHoursCsvController" ], "responses": { "200": { "description": "Summary of the hours-CSV upload (rows persisted + per-row errors)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "EmployerHoursCsvController.uploadHoursCsv" } }, "/companies/{companyId}/hours-csv-template": { "get": { "x-controller-name": "EmployerHoursCsvController", "x-operation-name": "downloadTemplate", "tags": [ "EmployerHoursCsvController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployerHoursCsvController.downloadTemplate" } }, "/companies/{id}/invite-user": { "post": { "x-controller-name": "CompaniesController", "x-operation-name": "inviteUser", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "Company model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "type": "string" }, "roleId": { "type": "number" }, "userId": { "type": "string" }, "sendInvite": { "type": "boolean" } } } } }, "x-parameter-index": 1 }, "operationId": "CompaniesController.inviteUser" } }, "/companies/{id}/logo-candidate/confirm": { "post": { "x-controller-name": "CompanyLogoCandidateController", "x-operation-name": "confirm", "tags": [ "CompanyLogoCandidateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Confirm a company logo candidate (super-user only)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "logoUrl": { "type": "string" }, "background": { "type": "string", "enum": [ "white", "grey", "indigo" ] } }, "additionalProperties": false } } }, "required": false, "x-parameter-index": 1 }, "operationId": "CompanyLogoCandidateController.confirm" } }, "/companies/{id}/logo-candidate/reject": { "post": { "x-controller-name": "CompanyLogoCandidateController", "x-operation-name": "reject", "tags": [ "CompanyLogoCandidateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Reject a company logo candidate (super-user only)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyLogoCandidateController.reject" } }, "/companies/{id}/logo-image-options": { "get": { "x-controller-name": "CompanyLogoCandidateController", "x-operation-name": "logoImageOptions", "tags": [ "CompanyLogoCandidateController" ], "responses": { "200": { "description": "Ranked image URLs harvested from a company's website, for manually picking a logo (super-user only)", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string", "enum": [ "img", "srcset", "link-icon", "og:image", "css-background", "google-favicon" ] }, "hint": { "type": "string", "enum": [ "logo", "icon", "other" ] }, "needsBackgroundVariant": { "type": "boolean" }, "backgroundPreviews": { "type": "object", "properties": { "white": { "type": "string" }, "grey": { "type": "string" }, "indigo": { "type": "string" } } } } } }, "truncated": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyLogoCandidateController.logoImageOptions" } }, "/companies/{id}/logo-lookup": { "post": { "x-controller-name": "CompanyLogoController", "x-operation-name": "lookup", "tags": [ "CompanyLogoController" ], "responses": { "200": { "description": "Look up (and, on a confirmed match, save) a company's logo from its recorded website (super-user only)", "content": { "application/json": { "schema": { "type": "object", "properties": { "logoUrl": { "type": "string", "nullable": true }, "reason": { "type": "string", "enum": [ "no_website", "not_found", "lookup_failed", "confirmed" ] } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyLogoController.lookup" } }, "/companies/{id}/logo-upload": { "post": { "x-controller-name": "CompanyLogoUploadController", "x-operation-name": "uploadLogo", "tags": [ "CompanyLogoUploadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Upload and store a company's logo image (super user or the company owner only)" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "CompanyLogoUploadController.uploadLogo" } }, "/companies/{companyId}/message-to-rep": { "post": { "x-controller-name": "EmployerDashboardController", "x-operation-name": "messageToRep", "tags": [ "EmployerDashboardController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Message delivered to the company sales rep" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" }, "subject": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "EmployerDashboardController.messageToRep" } }, "/companies/{companyId}/module-entitlements/{moduleKey}": { "post": { "x-controller-name": "CompanyModuleEntitlementsController", "x-operation-name": "enable", "tags": [ "CompanyModuleEntitlementsController" ], "responses": { "200": { "description": "The enabled entitlement row (existing row if already enabled)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyModuleEntitlement" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "moduleKey", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CompanyModuleEntitlementsController.enable" }, "delete": { "x-controller-name": "CompanyModuleEntitlementsController", "x-operation-name": "disable", "tags": [ "CompanyModuleEntitlementsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Module entitlement disabled (no-op if it was not enabled)" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "moduleKey", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CompanyModuleEntitlementsController.disable" } }, "/companies/{companyId}/module-entitlements": { "get": { "x-controller-name": "CompanyModuleEntitlementsController", "x-operation-name": "findForCompany", "tags": [ "CompanyModuleEntitlementsController" ], "responses": { "200": { "description": "The company's enabled module keys (presence of a row = enabled)", "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleKeys": { "type": "array", "items": { "type": "string" } } } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyModuleEntitlementsController.findForCompany" } }, "/companies/{companyId}/monthly-lives": { "get": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "monthlyLives", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.monthlyLives" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "month", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerLifeBillingController.monthlyLives" } }, "/companies/{companyId}/monthly-obligations/generate": { "post": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "runGenerateMonthlyObligations", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.runGenerateMonthlyObligations" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "month", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerLifeBillingController.runGenerateMonthlyObligations" } }, "/companies/{companyId}/monthly-obligations/preview": { "get": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "previewMonthlyObligations", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.previewMonthlyObligations" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "month", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerLifeBillingController.previewMonthlyObligations" } }, "/companies/{companyId}/nudge": { "post": { "x-controller-name": "CompanyNudgeController", "x-operation-name": "postNudge", "tags": [ "CompanyNudgeController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "What was sent, and when the next nudge is allowed" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyNudgeController.postNudge" }, "get": { "x-controller-name": "CompanyNudgeController", "x-operation-name": "getNudge", "tags": [ "CompanyNudgeController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The chase step pending for this company, if any" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyNudgeController.getNudge" } }, "/companies/{companyId}/pay-schedule": { "put": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "putSchedule", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.putSchedule" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PerLifeBillingController.putSchedule" }, "get": { "x-controller-name": "PerLifeBillingController", "x-operation-name": "getSchedule", "tags": [ "PerLifeBillingController" ], "responses": { "200": { "description": "Return value of PerLifeBillingController.getSchedule" } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PerLifeBillingController.getSchedule" } }, "/companies/{companyId}/payroll-credentials": { "get": { "x-controller-name": "PayrollCredentialsController", "x-operation-name": "listForCompany", "tags": [ "PayrollCredentialsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "All credential rows + recent access log, sanitized" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayrollCredentialsController.listForCompany" } }, "/companies/{companyId}/payroll-data-collections/current": { "get": { "x-controller-name": "PayrollDataCollectionsController", "x-operation-name": "findCurrentForCompany", "tags": [ "PayrollDataCollectionsController" ], "responses": { "200": { "description": "The current (latest) payroll-data collection period, or null", "content": { "application/json": { "schema": { "type": "object", "nullable": true } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayrollDataCollectionsController.findCurrentForCompany" } }, "/companies/{companyId}/payroll-data-collections": { "post": { "x-controller-name": "PayrollDataCollectionsController", "x-operation-name": "startNew", "tags": [ "PayrollDataCollectionsController" ], "responses": { "200": { "description": "The newly-started payroll-data collection period", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "periodLabel": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "PayrollDataCollectionsController.startNew" }, "get": { "x-controller-name": "PayrollDataCollectionsController", "x-operation-name": "findForCompany", "tags": [ "PayrollDataCollectionsController" ], "responses": { "200": { "description": "The company's payroll-data collection history", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayrollDataCollectionsController.findForCompany" } }, "/companies/{companyId}/payroll-data-method": { "patch": { "x-controller-name": "EmployerPhaseController", "x-operation-name": "setPayrollDataMethod", "tags": [ "EmployerPhaseController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Updated payroll method; returns the recomputed phase" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "method" ], "properties": { "method": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "EmployerPhaseController.setPayrollDataMethod" } }, "/companies/{companyId}/payroll-provider": { "patch": { "x-controller-name": "EmployerPhaseController", "x-operation-name": "setPayrollProvider", "tags": [ "EmployerPhaseController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Updated payroll provider; returns the recomputed phase" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "providerId" ], "properties": { "providerId": { "type": "string", "nullable": true }, "usesPeo": { "type": "boolean", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "EmployerPhaseController.setPayrollProvider" } }, "/companies/{companyId}/pending-elections": { "post": { "x-controller-name": "PendingElectionsController", "x-operation-name": "stageManually", "tags": [ "PendingElectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The staged (pending) election" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "employeeUserId" ], "properties": { "employeeUserId": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "PendingElectionsController.stageManually" } }, "/companies/{id}/portfolio-stats": { "get": { "x-controller-name": "CampaignsController", "x-operation-name": "portfolioStats", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "Partner-portal dashboard rollup: prospect/campaign totals, engagement, daily series", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.portfolioStats" } }, "/companies/{id}/presentation": { "get": { "x-controller-name": "CompanyPresentationController", "x-operation-name": "renderPresentation", "tags": [ "CompanyPresentationController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "templateId", "in": "query", "schema": { "type": "number" } }, { "name": "scope", "in": "query", "schema": { "type": "string" } } ], "operationId": "CompanyPresentationController.renderPresentation" } }, "/companies/{companyId}/proposal/accept": { "post": { "x-controller-name": "ProposalsController", "x-operation-name": "accept", "tags": [ "ProposalsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The accepted proposal" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProposalsController.accept" } }, "/companies/{companyId}/proposal/affiliate-summary": { "get": { "x-controller-name": "ProposalsController", "x-operation-name": "getAffiliateSummaryForCompany", "tags": [ "ProposalsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The affiliate-safe summary of a downline client's released proposal" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProposalsController.getAffiliateSummaryForCompany" } }, "/companies/{companyId}/proposal/generate-from-analysis": { "post": { "x-controller-name": "ProposalsController", "x-operation-name": "generateFromAnalysis", "tags": [ "ProposalsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The generated (and, for demo companies, released) proposal" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "analysisRunId": { "type": "string", "nullable": true }, "force": { "type": "boolean", "nullable": true } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "ProposalsController.generateFromAnalysis" } }, "/companies/{companyId}/proposal/generate-pdf": { "post": { "x-controller-name": "ProposalsController", "x-operation-name": "generatePdf", "tags": [ "ProposalsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The generated proposal PDF document" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProposalsController.generatePdf" } }, "/companies/{companyId}/proposal/release": { "post": { "x-controller-name": "ProposalsController", "x-operation-name": "release", "tags": [ "ProposalsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The released proposal" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProposalsController.release" } }, "/companies/{companyId}/proposal/seed": { "post": { "x-controller-name": "ProposalsController", "x-operation-name": "seed", "tags": [ "ProposalsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The (possibly pre-existing) proposal record" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProposalsController.seed" } }, "/companies/{companyId}/proposal": { "patch": { "x-controller-name": "ProposalsController", "x-operation-name": "update", "tags": [ "ProposalsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The updated proposal" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "employeeSavingsMonthly": { "type": "number", "nullable": true }, "employerSavingsAnnual": { "type": "number", "nullable": true }, "qualifiedCount": { "type": "number", "nullable": true }, "nonQualifiedCount": { "type": "number", "nullable": true }, "estimatedAnnualEmployerSavings": { "type": "number", "nullable": true }, "estimatedAnnualEmployeeSavings": { "type": "number", "nullable": true }, "notes": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "ProposalsController.update" }, "get": { "x-controller-name": "ProposalsController", "x-operation-name": "getForCompany", "tags": [ "ProposalsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The company's proposal (staff: any status; member: released+)" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProposalsController.getForCompany" } }, "/companies/{companyId}/provision-employee-invites": { "post": { "x-controller-name": "EmployerPhaseController", "x-operation-name": "provisionEmployeeInvites", "tags": [ "EmployerPhaseController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Runs the idempotent employee-invite provisioning pass; returns the counts" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployerPhaseController.provisionEmployeeInvites" } }, "/companies/{id}/set-industries": { "post": { "x-controller-name": "CompaniesController", "x-operation-name": "setCompanyIndustries", "tags": [ "CompaniesController" ], "responses": { "204": { "description": "Set company industries" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "CompaniesController.setCompanyIndustries" } }, "/companies/{companyId}/team-invites/{userCompanyId}/dispatch": { "post": { "x-controller-name": "EmployerPhaseController", "x-operation-name": "dispatchTeamInvite", "tags": [ "EmployerPhaseController" ], "responses": { "200": { "description": "Whether the invitation was sent, or the reason it was held (deferred until the BAA is signed)", "content": { "application/json": { "schema": { "type": "object", "properties": { "dispatched": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "userCompanyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "force": { "type": "boolean" } } } } }, "required": false, "x-parameter-index": 2 }, "operationId": "EmployerPhaseController.dispatchTeamInvite" } }, "/companies/{companyId}/team-invites": { "get": { "x-controller-name": "EmployerPhaseController", "x-operation-name": "getTeamInvites", "tags": [ "EmployerPhaseController" ], "responses": { "200": { "description": "The company members the employer invited, with invitation state", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "userCompanyId": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleGroupId": { "type": "number" }, "state": { "type": "string" }, "emailUndeliverable": { "type": "boolean" } } } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployerPhaseController.getTeamInvites" } }, "/companies/{companyId}/training-sessions": { "post": { "x-controller-name": "TrainingSessionsController", "x-operation-name": "create", "tags": [ "TrainingSessionsController" ], "responses": { "200": { "description": "The created training session", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scheduledAt": { "type": "string", "nullable": true }, "format": { "type": "string" }, "estimatedAttendees": { "type": "number", "nullable": true }, "audienceLabel": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "contactName": { "type": "string", "nullable": true }, "specialInstructions": { "type": "string", "nullable": true }, "status": { "type": "string" }, "meetingLink": { "type": "string", "nullable": true }, "assignedUserId": { "type": "string", "nullable": true }, "employerCommSentAt": { "type": "string", "nullable": true }, "employerCommSentBy": { "type": "string", "nullable": true }, "gaCommSentAt": { "type": "string", "nullable": true }, "gaCommSentBy": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "TrainingSessionsController.create" }, "get": { "x-controller-name": "TrainingSessionsController", "x-operation-name": "findForCompany", "tags": [ "TrainingSessionsController" ], "responses": { "200": { "description": "The company's training sessions", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TrainingSessionsController.findForCompany" } }, "/companies/{id}/users": { "get": { "x-controller-name": "CompaniesController", "x-operation-name": "getCompanyUsers", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "Company users", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.Filter" } } } } ], "operationId": "CompaniesController.getCompanyUsers" } }, "/companies/{id}/wellness-aggregates": { "get": { "x-controller-name": "CompanyWellnessAggregatesController", "x-operation-name": "findWellnessAggregates", "tags": [ "CompanyWellnessAggregatesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Suppressed employer wellness activity aggregates for the company" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "periodType", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "unsuppressed", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "CompanyWellnessAggregatesController.findWellnessAggregates" } }, "/companies/{id}": { "put": { "x-controller-name": "CompaniesController", "x-operation-name": "replaceById", "tags": [ "CompaniesController" ], "responses": { "204": { "description": "Company PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } }, "x-parameter-index": 1 }, "operationId": "CompaniesController.replaceById" }, "patch": { "x-controller-name": "CompaniesController", "x-operation-name": "updateById", "tags": [ "CompaniesController" ], "responses": { "204": { "description": "Company PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPartial" } } }, "x-parameter-index": 1 }, "operationId": "CompaniesController.updateById" }, "get": { "x-controller-name": "CompaniesController", "x-operation-name": "findById", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "Company model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.Filter" } } } } ], "operationId": "CompaniesController.findById" }, "delete": { "x-controller-name": "CompaniesController", "x-operation-name": "deleteById", "tags": [ "CompaniesController" ], "responses": { "204": { "description": "Company DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompaniesController.deleteById" } }, "/companies": { "post": { "x-controller-name": "CompaniesController", "x-operation-name": "create", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "Company model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCompany" } } } }, "operationId": "CompaniesController.create" }, "get": { "x-controller-name": "CompaniesController", "x-operation-name": "find", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "Array of Company model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.Filter1" } } } }, { "name": "adHocFilters", "in": "query", "schema": { "type": "string" } } ], "operationId": "CompaniesController.find" } }, "/company-document-access-logs": { "get": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "listAccessLogs", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Paginated slice of the company-document access log, newest first (SuperUser only)" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } }, { "name": "action", "in": "query", "schema": { "type": "string" } }, { "name": "actorType", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } }, { "name": "beforeId", "in": "query", "schema": { "type": "number" } } ], "operationId": "CompanyDocumentsController.listAccessLogs" } }, "/company-document-invites/{id}/revoke": { "post": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "revokeInvite", "tags": [ "CompanyDocumentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Invite revoked (idempotent)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyDocumentsController.revokeInvite" } }, "/company-document-shares/{token}/documents/{id}/download": { "get": { "x-controller-name": "CompanyDocumentSharedController", "x-operation-name": "downloadShared", "tags": [ "CompanyDocumentSharedController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyDocumentSharedController.downloadShared" } }, "/company-document-shares/{token}": { "get": { "x-controller-name": "CompanyDocumentSharedController", "x-operation-name": "viewShare", "tags": [ "CompanyDocumentSharedController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The invite's company documents (shared view)" } } } } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CompanyDocumentSharedController.viewShare" } }, "/company-documents/coverage": { "get": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "listCoverage", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-company synced-document coverage roster: {companyId, companyName, syncedDocCount, lastSyncedAt} for every company with at least one live synced document, most-recently-synced first (SuperUser only)" } } } } }, "operationId": "CompanyDocumentsController.listCoverage" } }, "/company-documents/stats": { "get": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "libraryStats", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Document Library coverage stat strip aggregates: companiesSynced, totalDocuments, undesignatedCount (SuperUser only)" } } } } }, "operationId": "CompanyDocumentsController.libraryStats" } }, "/company-documents/upload": { "post": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "upload", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "Uploaded company document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDocument" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CompanyDocumentsController.upload" } }, "/company-documents/{id}/download": { "get": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "download", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyDocumentsController.download" } }, "/company-documents/{id}": { "patch": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "update", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "Updated company document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDocument" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string" }, "notes": { "type": "string" }, "documentType": { "type": "string", "nullable": true }, "visibleToEmployer": { "type": "boolean" } } } } }, "x-parameter-index": 1 }, "operationId": "CompanyDocumentsController.update" }, "delete": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "softDelete", "tags": [ "CompanyDocumentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Company document soft-deleted" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyDocumentsController.softDelete" } }, "/company-documents": { "get": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "listLibrary", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Paginated page of live company documents across all companies, newest first (SuperUser only)" } } } } }, "parameters": [ { "name": "designation", "in": "query", "schema": { "type": "string" } }, { "name": "companyId", "in": "query", "schema": { "type": "number" } }, { "name": "provider", "in": "query", "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } } ], "operationId": "CompanyDocumentsController.listLibrary" } }, "/company-emails/{id}": { "patch": { "x-controller-name": "CompanyEmailsController", "x-operation-name": "update", "tags": [ "CompanyEmailsController" ], "responses": { "200": { "description": "Updated company email", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyEmail" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "label": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "CompanyEmailsController.update" }, "delete": { "x-controller-name": "CompanyEmailsController", "x-operation-name": "softDelete", "tags": [ "CompanyEmailsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Company email soft-deleted" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyEmailsController.softDelete" } }, "/company-groups/count": { "get": { "x-controller-name": "CompanyGroupController", "x-operation-name": "count", "tags": [ "CompanyGroupController" ], "responses": { "200": { "description": "CompanyGroup model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyGroupController.count" } }, "/company-groups/{id}": { "put": { "x-controller-name": "CompanyGroupController", "x-operation-name": "replaceById", "tags": [ "CompanyGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyGroup PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } }, "x-parameter-index": 1 }, "operationId": "CompanyGroupController.replaceById" }, "patch": { "x-controller-name": "CompanyGroupController", "x-operation-name": "updateById", "tags": [ "CompanyGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyGroup PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "CompanyGroupController.updateById" }, "get": { "x-controller-name": "CompanyGroupController", "x-operation-name": "findById", "tags": [ "CompanyGroupController" ], "responses": { "200": { "description": "CompanyGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroupWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroup.Filter" } } } } ], "operationId": "CompanyGroupController.findById" }, "delete": { "x-controller-name": "CompanyGroupController", "x-operation-name": "deleteById", "tags": [ "CompanyGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyGroup DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyGroupController.deleteById" } }, "/company-groups": { "post": { "x-controller-name": "CompanyGroupController", "x-operation-name": "create", "tags": [ "CompanyGroupController" ], "responses": { "200": { "description": "CompanyGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCompanyGroup" } } } }, "operationId": "CompanyGroupController.create" }, "patch": { "x-controller-name": "CompanyGroupController", "x-operation-name": "updateAll", "tags": [ "CompanyGroupController" ], "responses": { "200": { "description": "CompanyGroup PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroupPartial" } } } }, "operationId": "CompanyGroupController.updateAll" }, "get": { "x-controller-name": "CompanyGroupController", "x-operation-name": "find", "tags": [ "CompanyGroupController" ], "responses": { "200": { "description": "Array of CompanyGroup model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyGroupWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroup.Filter1" } } } } ], "operationId": "CompanyGroupController.find" } }, "/company-locations/count": { "get": { "x-controller-name": "CompanyLocationsController", "x-operation-name": "count", "tags": [ "CompanyLocationsController" ], "responses": { "200": { "description": "CompanyLocations model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyLocations.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyLocationsController.count" } }, "/company-locations/{id}": { "put": { "x-controller-name": "CompanyLocationsController", "x-operation-name": "replaceById", "tags": [ "CompanyLocationsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyLocations PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLocations" } } }, "x-parameter-index": 1 }, "operationId": "CompanyLocationsController.replaceById" }, "patch": { "x-controller-name": "CompanyLocationsController", "x-operation-name": "updateById", "tags": [ "CompanyLocationsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyLocations PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLocationsPartial" } } }, "x-parameter-index": 1 }, "operationId": "CompanyLocationsController.updateById" }, "get": { "x-controller-name": "CompanyLocationsController", "x-operation-name": "findById", "tags": [ "CompanyLocationsController" ], "responses": { "200": { "description": "CompanyLocations model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLocationsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLocations.Filter" } } } } ], "operationId": "CompanyLocationsController.findById" }, "delete": { "x-controller-name": "CompanyLocationsController", "x-operation-name": "deleteById", "tags": [ "CompanyLocationsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyLocations DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyLocationsController.deleteById" } }, "/company-locations": { "post": { "x-controller-name": "CompanyLocationsController", "x-operation-name": "create", "tags": [ "CompanyLocationsController" ], "responses": { "200": { "description": "CompanyLocations model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLocations" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCompanyLocations" } } } }, "operationId": "CompanyLocationsController.create" }, "patch": { "x-controller-name": "CompanyLocationsController", "x-operation-name": "updateAll", "tags": [ "CompanyLocationsController" ], "responses": { "200": { "description": "CompanyLocations PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyLocations.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLocationsPartial" } } } }, "operationId": "CompanyLocationsController.updateAll" }, "get": { "x-controller-name": "CompanyLocationsController", "x-operation-name": "find", "tags": [ "CompanyLocationsController" ], "responses": { "200": { "description": "Array of CompanyLocations model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyLocationsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLocations.Filter1" } } } } ], "operationId": "CompanyLocationsController.find" } }, "/company-logo-candidates/run": { "post": { "x-controller-name": "CompanyLogoCandidateController", "x-operation-name": "run", "tags": [ "CompanyLogoCandidateController" ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "description": "Start deriving logo candidates for every unreviewed company; returns immediately, poll GET /company-logo-candidates for progress (super-user only)" } } } } }, "operationId": "CompanyLogoCandidateController.run" } }, "/company-logo-candidates": { "get": { "x-controller-name": "CompanyLogoCandidateController", "x-operation-name": "list", "tags": [ "CompanyLogoCandidateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Logo candidates awaiting review, with the evidence behind each (super-user only)" } } } } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } } ], "operationId": "CompanyLogoCandidateController.list" } }, "/company-mandate-assignments/count": { "get": { "x-controller-name": "CompanyMandateAssignmentController", "x-operation-name": "count", "tags": [ "CompanyMandateAssignmentController" ], "responses": { "200": { "description": "CompanyMandateAssignment model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyMandateAssignment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyMandateAssignmentController.count" } }, "/company-mandate-assignments/{id}": { "put": { "x-controller-name": "CompanyMandateAssignmentController", "x-operation-name": "replaceById", "tags": [ "CompanyMandateAssignmentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyMandateAssignment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMandateAssignment" } } }, "x-parameter-index": 1 }, "operationId": "CompanyMandateAssignmentController.replaceById" }, "patch": { "x-controller-name": "CompanyMandateAssignmentController", "x-operation-name": "updateById", "tags": [ "CompanyMandateAssignmentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyMandateAssignment PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMandateAssignmentPartial" } } }, "x-parameter-index": 1 }, "operationId": "CompanyMandateAssignmentController.updateById" }, "get": { "x-controller-name": "CompanyMandateAssignmentController", "x-operation-name": "findById", "tags": [ "CompanyMandateAssignmentController" ], "responses": { "200": { "description": "CompanyMandateAssignment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMandateAssignmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMandateAssignment.Filter" } } } } ], "operationId": "CompanyMandateAssignmentController.findById" }, "delete": { "x-controller-name": "CompanyMandateAssignmentController", "x-operation-name": "deleteById", "tags": [ "CompanyMandateAssignmentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyMandateAssignment DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyMandateAssignmentController.deleteById" } }, "/company-mandate-assignments": { "post": { "x-controller-name": "CompanyMandateAssignmentController", "x-operation-name": "create", "tags": [ "CompanyMandateAssignmentController" ], "responses": { "200": { "description": "CompanyMandateAssignment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMandateAssignment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCompanyMandateAssignment" } } } }, "operationId": "CompanyMandateAssignmentController.create" }, "patch": { "x-controller-name": "CompanyMandateAssignmentController", "x-operation-name": "updateAll", "tags": [ "CompanyMandateAssignmentController" ], "responses": { "200": { "description": "CompanyMandateAssignment PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyMandateAssignment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMandateAssignmentPartial" } } } }, "operationId": "CompanyMandateAssignmentController.updateAll" }, "get": { "x-controller-name": "CompanyMandateAssignmentController", "x-operation-name": "find", "tags": [ "CompanyMandateAssignmentController" ], "responses": { "200": { "description": "Array of CompanyMandateAssignment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyMandateAssignmentWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMandateAssignment.Filter1" } } } } ], "operationId": "CompanyMandateAssignmentController.find" } }, "/company-product-stages/count": { "get": { "x-controller-name": "CompanyProductStagesController", "x-operation-name": "count", "tags": [ "CompanyProductStagesController" ], "responses": { "200": { "description": "CompanyProductStage model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyProductStage.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyProductStagesController.count" } }, "/company-product-stages/{id}": { "put": { "x-controller-name": "CompanyProductStagesController", "x-operation-name": "replaceById", "tags": [ "CompanyProductStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyProductStage PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyProductStage" } } }, "x-parameter-index": 1 }, "operationId": "CompanyProductStagesController.replaceById" }, "patch": { "x-controller-name": "CompanyProductStagesController", "x-operation-name": "updateById", "tags": [ "CompanyProductStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyProductStage PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyProductStagePartial" } } }, "x-parameter-index": 1 }, "operationId": "CompanyProductStagesController.updateById" }, "get": { "x-controller-name": "CompanyProductStagesController", "x-operation-name": "findById", "tags": [ "CompanyProductStagesController" ], "responses": { "200": { "description": "CompanyProductStage model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyProductStageWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyProductStage.Filter" } } } } ], "operationId": "CompanyProductStagesController.findById" }, "delete": { "x-controller-name": "CompanyProductStagesController", "x-operation-name": "deleteById", "tags": [ "CompanyProductStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyProductStage DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyProductStagesController.deleteById" } }, "/company-product-stages": { "post": { "x-controller-name": "CompanyProductStagesController", "x-operation-name": "create", "tags": [ "CompanyProductStagesController" ], "responses": { "200": { "description": "CompanyProductStage model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyProductStage" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCompanyProductStage" } } } }, "operationId": "CompanyProductStagesController.create" }, "patch": { "x-controller-name": "CompanyProductStagesController", "x-operation-name": "updateAll", "tags": [ "CompanyProductStagesController" ], "responses": { "200": { "description": "CompanyProductStage PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyProductStage.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyProductStagePartial" } } } }, "operationId": "CompanyProductStagesController.updateAll" }, "get": { "x-controller-name": "CompanyProductStagesController", "x-operation-name": "find", "tags": [ "CompanyProductStagesController" ], "responses": { "200": { "description": "Array of CompanyProductStage model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyProductStageWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyProductStage.Filter1" } } } } ], "operationId": "CompanyProductStagesController.find" } }, "/company-repair-stages/count": { "get": { "x-controller-name": "CompanyRepairStagesController", "x-operation-name": "count", "tags": [ "CompanyRepairStagesController" ], "responses": { "200": { "description": "CompanyRepairStages model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyRepairStages.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyRepairStagesController.count" } }, "/company-repair-stages/{id}": { "put": { "x-controller-name": "CompanyRepairStagesController", "x-operation-name": "replaceById", "tags": [ "CompanyRepairStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyRepairStages PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRepairStages" } } }, "x-parameter-index": 1 }, "operationId": "CompanyRepairStagesController.replaceById" }, "patch": { "x-controller-name": "CompanyRepairStagesController", "x-operation-name": "updateById", "tags": [ "CompanyRepairStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyRepairStages PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRepairStagesPartial" } } }, "x-parameter-index": 1 }, "operationId": "CompanyRepairStagesController.updateById" }, "get": { "x-controller-name": "CompanyRepairStagesController", "x-operation-name": "findById", "tags": [ "CompanyRepairStagesController" ], "responses": { "200": { "description": "CompanyRepairStages model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRepairStagesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRepairStages.Filter" } } } } ], "operationId": "CompanyRepairStagesController.findById" }, "delete": { "x-controller-name": "CompanyRepairStagesController", "x-operation-name": "deleteById", "tags": [ "CompanyRepairStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompanyRepairStages DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyRepairStagesController.deleteById" } }, "/company-repair-stages": { "post": { "x-controller-name": "CompanyRepairStagesController", "x-operation-name": "create", "tags": [ "CompanyRepairStagesController" ], "responses": { "200": { "description": "CompanyRepairStages model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRepairStages" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCompanyRepairStages" } } } }, "operationId": "CompanyRepairStagesController.create" }, "patch": { "x-controller-name": "CompanyRepairStagesController", "x-operation-name": "updateAll", "tags": [ "CompanyRepairStagesController" ], "responses": { "200": { "description": "CompanyRepairStages PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyRepairStages.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRepairStagesPartial" } } } }, "operationId": "CompanyRepairStagesController.updateAll" }, "get": { "x-controller-name": "CompanyRepairStagesController", "x-operation-name": "find", "tags": [ "CompanyRepairStagesController" ], "responses": { "200": { "description": "Array of CompanyRepairStages model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRepairStagesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRepairStages.Filter1" } } } } ], "operationId": "CompanyRepairStagesController.find" } }, "/company-review-users": { "post": { "x-controller-name": "CompanyReviewUsersController", "x-operation-name": "create", "tags": [ "CompanyReviewUsersController" ], "responses": { "200": { "description": "Company review user model instance", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyReviewUsers" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyReviewUsers" } } } } }, "operationId": "CompanyReviewUsersController.create" }, "get": { "x-controller-name": "CompanyReviewUsersController", "x-operation-name": "find", "tags": [ "CompanyReviewUsersController" ], "responses": { "200": { "description": "Company review users model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyReviewUsersWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyReviewUsers.Filter" } } } } ], "operationId": "CompanyReviewUsersController.find" } }, "/company-types": { "get": { "x-controller-name": "CompanyTypesController", "x-operation-name": "companyTypes", "tags": [ "CompanyTypesController" ], "responses": { "200": { "description": "Canonical company-type dropdown options", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string" } } } } } } } }, "operationId": "CompanyTypesController.companyTypes" } }, "/company-watchers/{companyId}": { "delete": { "x-controller-name": "CompanyWatchersController", "x-operation-name": "unwatch", "tags": [ "CompanyWatchersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Unwatch a company (caller-scoped)" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyWatchersController.unwatch" } }, "/company-watchers": { "post": { "x-controller-name": "CompanyWatchersController", "x-operation-name": "watch", "tags": [ "CompanyWatchersController" ], "responses": { "200": { "description": "Watch a company (idempotent) — returns the watcher row", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyWatchers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchCompany" } } } }, "operationId": "CompanyWatchersController.watch" }, "get": { "x-controller-name": "CompanyWatchersController", "x-operation-name": "find", "tags": [ "CompanyWatchersController" ], "responses": { "200": { "description": "Company watcher rows, scoped to the caller's own userId", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWatchersWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyWatchers.Filter" } } } } ], "operationId": "CompanyWatchersController.find" } }, "/comparison-types/count": { "get": { "x-controller-name": "ComparrisonTypesController", "x-operation-name": "count", "tags": [ "ComparrisonTypesController" ], "responses": { "200": { "description": "ComparrisonTypes model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ComparrisonTypes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ComparrisonTypesController.count" } }, "/comparison-types/{id}": { "put": { "x-controller-name": "ComparrisonTypesController", "x-operation-name": "replaceById", "tags": [ "ComparrisonTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ComparrisonTypes PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparrisonTypes" } } }, "x-parameter-index": 1 }, "operationId": "ComparrisonTypesController.replaceById" }, "patch": { "x-controller-name": "ComparrisonTypesController", "x-operation-name": "updateById", "tags": [ "ComparrisonTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ComparrisonTypes PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparrisonTypesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ComparrisonTypesController.updateById" }, "get": { "x-controller-name": "ComparrisonTypesController", "x-operation-name": "findById", "tags": [ "ComparrisonTypesController" ], "responses": { "200": { "description": "ComparrisonTypes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparrisonTypesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparrisonTypes.Filter" } } } } ], "operationId": "ComparrisonTypesController.findById" }, "delete": { "x-controller-name": "ComparrisonTypesController", "x-operation-name": "deleteById", "tags": [ "ComparrisonTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ComparrisonTypes DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ComparrisonTypesController.deleteById" } }, "/comparison-types": { "post": { "x-controller-name": "ComparrisonTypesController", "x-operation-name": "create", "tags": [ "ComparrisonTypesController" ], "responses": { "200": { "description": "ComparrisonTypes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparrisonTypes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewComparrisonTypes" } } } }, "operationId": "ComparrisonTypesController.create" }, "patch": { "x-controller-name": "ComparrisonTypesController", "x-operation-name": "updateAll", "tags": [ "ComparrisonTypesController" ], "responses": { "200": { "description": "ComparrisonTypes PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ComparrisonTypes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparrisonTypesPartial" } } } }, "operationId": "ComparrisonTypesController.updateAll" }, "get": { "x-controller-name": "ComparrisonTypesController", "x-operation-name": "find", "tags": [ "ComparrisonTypesController" ], "responses": { "200": { "description": "Array of ComparrisonTypes model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComparrisonTypesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparrisonTypes.Filter1" } } } } ], "operationId": "ComparrisonTypesController.find" } }, "/config/commission-defaults": { "patch": { "x-controller-name": "ConfigController", "x-operation-name": "updateCommissionDefaults", "tags": [ "ConfigController" ], "responses": { "200": { "description": "Updated affiliate-invite commission defaults" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ConfigController.updateCommissionDefaults" }, "get": { "x-controller-name": "ConfigController", "x-operation-name": "getCommissionDefaults", "tags": [ "ConfigController" ], "responses": { "200": { "description": "Affiliate-invite commission defaults" } }, "operationId": "ConfigController.getCommissionDefaults" } }, "/config/feature-flags": { "patch": { "x-controller-name": "ConfigController", "x-operation-name": "updateFeatureFlags", "tags": [ "ConfigController" ], "responses": { "200": { "description": "Updated feature flags" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ConfigController.updateFeatureFlags" }, "get": { "x-controller-name": "ConfigController", "x-operation-name": "getFeatureFlags", "tags": [ "ConfigController" ], "responses": { "200": { "description": "Feature flags (readable by any authenticated user)" } }, "operationId": "ConfigController.getFeatureFlags" } }, "/contracts/create": { "get": { "x-controller-name": "CreateContractController", "x-operation-name": "downloadContract", "tags": [ "CreateContractController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "fieldName", "in": "query", "schema": { "type": "string" } }, { "name": "contractType", "in": "query", "schema": { "type": "string" } }, { "name": "processflowId", "in": "query", "schema": { "type": "string" } }, { "name": "signed", "in": "query", "schema": { "type": "string" } }, { "name": "site", "in": "query", "schema": { "type": "string" } }, { "name": "token", "in": "query", "schema": { "type": "string" } } ], "operationId": "CreateContractController.downloadContract" } }, "/contracts/create-from-data": { "post": { "x-controller-name": "CreateContractController", "x-operation-name": "createContractFromData", "tags": [ "CreateContractController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "contractType" ], "maxProperties": 200, "properties": { "contractType": { "type": "string", "maxLength": 255 }, "accountNumber": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "bankAddress": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "bankName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "cityStateZip": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "companyAddress": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "companyEmail": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "companyPhone": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "companyState": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "companyType": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "date": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "debugFieldMode": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "depositorName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "effectiveDate": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "ein": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "entityType": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "exemptPayeeCode": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "fatcaCode": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "foreignPartners": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "llcClassification": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "otherClassification": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "perEntireMonthlyLifePerMonth": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "printName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "providerAddress": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "providerEntity": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "providerName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "providerPhone": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "referralRatePerEntireMonthlyLifePerMonth": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "routingNumber": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "signDate": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "signature": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "signerName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "signerTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "tin": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "tinType": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "providerLogoUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "pdfFieldValues": { "type": "object", "maxProperties": 500, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "object" }, { "type": "array" } ] } } } }, "description": "Create a contract by passing explicit field values", "required": true }, "operationId": "CreateContractController.createContractFromData" } }, "/contracts/email": { "post": { "x-controller-name": "CreateContractController", "x-operation-name": "reactEmail", "tags": [ "CreateContractController" ], "responses": { "200": { "description": "Return value of CreateContractController.reactEmail" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "site", "to", "processFlowId" ], "properties": { "site": { "type": "string" }, "to": { "type": "string" }, "userId": { "type": "string" }, "type": { "type": "string" }, "processFlowId": { "type": "number" } } } } }, "description": "Required input for sending emails", "required": true }, "operationId": "CreateContractController.reactEmail" } }, "/contracts/personalized-template": { "post": { "x-controller-name": "CreateContractController", "x-operation-name": "getPersonalizedContractTemplate", "tags": [ "CreateContractController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyName" ], "properties": { "companyName": { "type": "string" }, "entityDescription": { "type": "string" }, "address": { "type": "string" }, "signerName": { "type": "string" }, "signerTitle": { "type": "string" } } } } }, "description": "Affiliate Word template with Group Advisors' identity replaced by the caller's (the parent affiliate contracting with their own sub-affiliate). Word-only: the PDF template's identity text is static and cannot reflow (board #1046 tracks adding party form fields in the template rewrite).", "required": true }, "operationId": "CreateContractController.getPersonalizedContractTemplate" } }, "/contracts/template": { "get": { "x-controller-name": "CreateContractController", "x-operation-name": "getContractTemplate", "tags": [ "CreateContractController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "contractType", "in": "query", "schema": { "type": "string" } }, { "name": "format", "in": "query", "schema": { "type": "string" } } ], "operationId": "CreateContractController.getContractTemplate" } }, "/conversion-backstop/pending-matches/count": { "get": { "x-controller-name": "ConversionBackstopController", "x-operation-name": "count", "tags": [ "ConversionBackstopController" ], "responses": { "200": { "description": "Count of pending conversion matches (for the review badge)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "ConversionBackstopController.count" } }, "/conversion-backstop/pending-matches/{id}/confirm": { "post": { "x-controller-name": "ConversionBackstopController", "x-operation-name": "confirm", "tags": [ "ConversionBackstopController" ], "responses": { "200": { "description": "Confirm a match: link the prospect + stamp the owning partner", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ConversionBackstopController.confirm" } }, "/conversion-backstop/pending-matches/{id}/dismiss": { "post": { "x-controller-name": "ConversionBackstopController", "x-operation-name": "dismiss", "tags": [ "ConversionBackstopController" ], "responses": { "200": { "description": "Dismiss a match (no side effects)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ConversionBackstopController.dismiss" } }, "/conversion-backstop/pending-matches": { "get": { "x-controller-name": "ConversionBackstopController", "x-operation-name": "list", "tags": [ "ConversionBackstopController" ], "responses": { "200": { "description": "Pending conversion matches for super-user review (enriched)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } } ], "operationId": "ConversionBackstopController.list" } }, "/create-client": { "post": { "x-controller-name": "CreateClientController", "x-operation-name": "createClient", "tags": [ "CreateClientController" ], "responses": { "200": { "description": "Atomically created user + company (with role links + initial stage)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "roleGroupIds" ], "properties": { "email": { "type": "string" }, "roleGroupIds": { "type": "array", "items": { "type": "number" } } }, "additionalProperties": true } } } }, "operationId": "CreateClientController.createClient" } }, "/dashboard-layouts/{dashboardKey}": { "put": { "x-controller-name": "DashboardLayoutController", "x-operation-name": "upsertMine", "tags": [ "DashboardLayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Upsert the caller's saved layout for the role-dashboard." } } } } }, "parameters": [ { "name": "dashboardKey", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardLayoutSave" } } }, "x-parameter-index": 1 }, "operationId": "DashboardLayoutController.upsertMine" }, "get": { "x-controller-name": "DashboardLayoutController", "x-operation-name": "findMine", "tags": [ "DashboardLayoutController" ], "responses": { "200": { "description": "The caller's saved layout for the role-dashboard, or null when none.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dashboardKey": { "type": "string" }, "layout": { "type": "object", "nullable": true, "properties": { "version": { "type": "number" }, "modules": { "type": "array", "items": { "type": "object", "required": [ "id", "hidden" ], "properties": { "id": { "type": "string" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" } } } }, "layouts": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "required": [ "i", "x", "y", "w", "h" ], "properties": { "i": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" } } } } } } } } } } } } }, "parameters": [ { "name": "dashboardKey", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DashboardLayoutController.findMine" } }, "/deal-tag-options/count": { "get": { "x-controller-name": "DealTagOptionsController", "x-operation-name": "count", "tags": [ "DealTagOptionsController" ], "responses": { "200": { "description": "DealTagOptions model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DealTagOptions.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DealTagOptionsController.count" } }, "/deal-tag-options/{id}": { "put": { "x-controller-name": "DealTagOptionsController", "x-operation-name": "replaceById", "tags": [ "DealTagOptionsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DealTagOptions PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTagOptions" } } }, "x-parameter-index": 1 }, "operationId": "DealTagOptionsController.replaceById" }, "patch": { "x-controller-name": "DealTagOptionsController", "x-operation-name": "updateById", "tags": [ "DealTagOptionsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DealTagOptions PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTagOptionsPartial" } } }, "x-parameter-index": 1 }, "operationId": "DealTagOptionsController.updateById" }, "get": { "x-controller-name": "DealTagOptionsController", "x-operation-name": "findById", "tags": [ "DealTagOptionsController" ], "responses": { "200": { "description": "DealTagOptions model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTagOptionsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTagOptions.Filter" } } } } ], "operationId": "DealTagOptionsController.findById" }, "delete": { "x-controller-name": "DealTagOptionsController", "x-operation-name": "deleteById", "tags": [ "DealTagOptionsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DealTagOptions DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DealTagOptionsController.deleteById" } }, "/deal-tag-options": { "post": { "x-controller-name": "DealTagOptionsController", "x-operation-name": "create", "tags": [ "DealTagOptionsController" ], "responses": { "200": { "description": "DealTagOptions model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTagOptions" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDealTagOptions" } } } }, "operationId": "DealTagOptionsController.create" }, "patch": { "x-controller-name": "DealTagOptionsController", "x-operation-name": "updateAll", "tags": [ "DealTagOptionsController" ], "responses": { "200": { "description": "DealTagOptions PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DealTagOptions.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTagOptionsPartial" } } } }, "operationId": "DealTagOptionsController.updateAll" }, "get": { "x-controller-name": "DealTagOptionsController", "x-operation-name": "find", "tags": [ "DealTagOptionsController" ], "responses": { "200": { "description": "Array of DealTagOptions model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealTagOptionsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTagOptions.Filter1" } } } } ], "operationId": "DealTagOptionsController.find" } }, "/deal-tags/count": { "get": { "x-controller-name": "DealTagsController", "x-operation-name": "count", "tags": [ "DealTagsController" ], "responses": { "200": { "description": "DealTags model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DealTags.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DealTagsController.count" } }, "/deal-tags/{id}": { "put": { "x-controller-name": "DealTagsController", "x-operation-name": "replaceById", "tags": [ "DealTagsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DealTags PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTags" } } }, "x-parameter-index": 1 }, "operationId": "DealTagsController.replaceById" }, "patch": { "x-controller-name": "DealTagsController", "x-operation-name": "updateById", "tags": [ "DealTagsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DealTags PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTagsPartial" } } }, "x-parameter-index": 1 }, "operationId": "DealTagsController.updateById" }, "get": { "x-controller-name": "DealTagsController", "x-operation-name": "findById", "tags": [ "DealTagsController" ], "responses": { "200": { "description": "DealTags model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTagsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTags.Filter" } } } } ], "operationId": "DealTagsController.findById" }, "delete": { "x-controller-name": "DealTagsController", "x-operation-name": "deleteById", "tags": [ "DealTagsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DealTags DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DealTagsController.deleteById" } }, "/deal-tags": { "post": { "x-controller-name": "DealTagsController", "x-operation-name": "create", "tags": [ "DealTagsController" ], "responses": { "200": { "description": "DealTags model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTags" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDealTags" } } } }, "operationId": "DealTagsController.create" }, "patch": { "x-controller-name": "DealTagsController", "x-operation-name": "updateAll", "tags": [ "DealTagsController" ], "responses": { "200": { "description": "DealTags PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DealTags.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTagsPartial" } } } }, "operationId": "DealTagsController.updateAll" }, "get": { "x-controller-name": "DealTagsController", "x-operation-name": "find", "tags": [ "DealTagsController" ], "responses": { "200": { "description": "Array of DealTags model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealTagsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTags.Filter1" } } } } ], "operationId": "DealTagsController.find" } }, "/deals/count": { "get": { "x-controller-name": "DealsController", "x-operation-name": "count", "tags": [ "DealsController" ], "responses": { "200": { "description": "Deals model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Deals.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DealsController.count" } }, "/deals/{id}": { "put": { "x-controller-name": "DealsController", "x-operation-name": "replaceById", "tags": [ "DealsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Deals PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deals" } } }, "x-parameter-index": 1 }, "operationId": "DealsController.replaceById" }, "patch": { "x-controller-name": "DealsController", "x-operation-name": "updateById", "tags": [ "DealsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Deals PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealsPartial" } } }, "x-parameter-index": 1 }, "operationId": "DealsController.updateById" }, "get": { "x-controller-name": "DealsController", "x-operation-name": "findById", "tags": [ "DealsController" ], "responses": { "200": { "description": "Deals model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deals.Filter" } } } } ], "operationId": "DealsController.findById" }, "delete": { "x-controller-name": "DealsController", "x-operation-name": "deleteById", "tags": [ "DealsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Deals DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DealsController.deleteById" } }, "/deals": { "post": { "x-controller-name": "DealsController", "x-operation-name": "create", "tags": [ "DealsController" ], "responses": { "200": { "description": "Deals model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deals" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDeals" } } } }, "operationId": "DealsController.create" }, "patch": { "x-controller-name": "DealsController", "x-operation-name": "updateAll", "tags": [ "DealsController" ], "responses": { "200": { "description": "Deals PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Deals.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealsPartial" } } } }, "operationId": "DealsController.updateAll" }, "get": { "x-controller-name": "DealsController", "x-operation-name": "find", "tags": [ "DealsController" ], "responses": { "200": { "description": "Array of Deals model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deals.Filter1" } } } } ], "operationId": "DealsController.find" } }, "/default-sources/count": { "get": { "x-controller-name": "DefaultSourcesController", "x-operation-name": "count", "tags": [ "DefaultSourcesController" ], "responses": { "200": { "description": "DefaultSources model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DefaultSources.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DefaultSourcesController.count" } }, "/default-sources/{id}": { "put": { "x-controller-name": "DefaultSourcesController", "x-operation-name": "replaceById", "tags": [ "DefaultSourcesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DefaultSources PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultSources" } } }, "x-parameter-index": 1 }, "operationId": "DefaultSourcesController.replaceById" }, "patch": { "x-controller-name": "DefaultSourcesController", "x-operation-name": "updateById", "tags": [ "DefaultSourcesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DefaultSources PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultSourcesPartial" } } }, "x-parameter-index": 1 }, "operationId": "DefaultSourcesController.updateById" }, "get": { "x-controller-name": "DefaultSourcesController", "x-operation-name": "findById", "tags": [ "DefaultSourcesController" ], "responses": { "200": { "description": "DefaultSources model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultSourcesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultSources.Filter" } } } } ], "operationId": "DefaultSourcesController.findById" }, "delete": { "x-controller-name": "DefaultSourcesController", "x-operation-name": "deleteById", "tags": [ "DefaultSourcesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DefaultSources DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DefaultSourcesController.deleteById" } }, "/default-sources": { "post": { "x-controller-name": "DefaultSourcesController", "x-operation-name": "create", "tags": [ "DefaultSourcesController" ], "responses": { "200": { "description": "DefaultSources model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultSources" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDefaultSources" } } } }, "operationId": "DefaultSourcesController.create" }, "patch": { "x-controller-name": "DefaultSourcesController", "x-operation-name": "updateAll", "tags": [ "DefaultSourcesController" ], "responses": { "200": { "description": "DefaultSources PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DefaultSources.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultSourcesPartial" } } } }, "operationId": "DefaultSourcesController.updateAll" }, "get": { "x-controller-name": "DefaultSourcesController", "x-operation-name": "find", "tags": [ "DefaultSourcesController" ], "responses": { "200": { "description": "Array of DefaultSources model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultSourcesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultSources.Filter1" } } } } ], "operationId": "DefaultSourcesController.find" } }, "/default-users/count": { "get": { "x-controller-name": "DefaultUserController", "x-operation-name": "count", "tags": [ "DefaultUserController" ], "responses": { "200": { "description": "DefaultUser model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DefaultUser.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DefaultUserController.count" } }, "/default-users/{id}": { "put": { "x-controller-name": "DefaultUserController", "x-operation-name": "replaceById", "tags": [ "DefaultUserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DefaultUser PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultUser" } } }, "x-parameter-index": 1 }, "operationId": "DefaultUserController.replaceById" }, "patch": { "x-controller-name": "DefaultUserController", "x-operation-name": "updateById", "tags": [ "DefaultUserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DefaultUser PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultUserPartial" } } }, "x-parameter-index": 1 }, "operationId": "DefaultUserController.updateById" }, "get": { "x-controller-name": "DefaultUserController", "x-operation-name": "findById", "tags": [ "DefaultUserController" ], "responses": { "200": { "description": "DefaultUser model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultUserWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultUser.Filter" } } } } ], "operationId": "DefaultUserController.findById" }, "delete": { "x-controller-name": "DefaultUserController", "x-operation-name": "deleteById", "tags": [ "DefaultUserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DefaultUser DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DefaultUserController.deleteById" } }, "/default-users": { "post": { "x-controller-name": "DefaultUserController", "x-operation-name": "create", "tags": [ "DefaultUserController" ], "responses": { "200": { "description": "DefaultUser model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultUser" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDefaultUser" } } } }, "operationId": "DefaultUserController.create" }, "patch": { "x-controller-name": "DefaultUserController", "x-operation-name": "updateAll", "tags": [ "DefaultUserController" ], "responses": { "200": { "description": "DefaultUser PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DefaultUser.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultUserPartial" } } } }, "operationId": "DefaultUserController.updateAll" }, "get": { "x-controller-name": "DefaultUserController", "x-operation-name": "find", "tags": [ "DefaultUserController" ], "responses": { "200": { "description": "Array of DefaultUser model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultUserWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultUser.Filter1" } } } } ], "operationId": "DefaultUserController.find" } }, "/demo/deck": { "get": { "x-controller-name": "DemoDeckController", "x-operation-name": "deckHtml", "tags": [ "DemoDeckController" ], "responses": { "200": { "description": "Return value of DemoDeckController.deckHtml" } }, "operationId": "DemoDeckController.deckHtml" } }, "/demo/deck-darkmode.pdf": { "get": { "x-controller-name": "DemoDeckController", "x-operation-name": "deckPdfDark", "tags": [ "DemoDeckController" ], "responses": { "200": { "description": "Return value of DemoDeckController.deckPdfDark" } }, "operationId": "DemoDeckController.deckPdfDark" } }, "/demo/deck.pdf": { "get": { "x-controller-name": "DemoDeckController", "x-operation-name": "deckPdf", "tags": [ "DemoDeckController" ], "responses": { "200": { "description": "Return value of DemoDeckController.deckPdf" } }, "operationId": "DemoDeckController.deckPdf" } }, "/devices/{deviceUuid}": { "delete": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "revokeMyDevice", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Revoke one of the caller's own devices", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "deviceUuid", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ClearErcUsersController.revokeMyDevice" } }, "/devices": { "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "listMyDevices", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "The authenticated caller's own registered devices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } } } }, "operationId": "ClearErcUsersController.listMyDevices" } }, "/document-categories/count": { "get": { "x-controller-name": "DocumentCategoryController", "x-operation-name": "count", "tags": [ "DocumentCategoryController" ], "responses": { "200": { "description": "DocumentCategory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DocumentCategory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DocumentCategoryController.count" } }, "/document-categories/{id}": { "put": { "x-controller-name": "DocumentCategoryController", "x-operation-name": "replaceById", "tags": [ "DocumentCategoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DocumentCategory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCategory" } } }, "x-parameter-index": 1 }, "operationId": "DocumentCategoryController.replaceById" }, "patch": { "x-controller-name": "DocumentCategoryController", "x-operation-name": "updateById", "tags": [ "DocumentCategoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DocumentCategory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCategoryPartial" } } }, "x-parameter-index": 1 }, "operationId": "DocumentCategoryController.updateById" }, "get": { "x-controller-name": "DocumentCategoryController", "x-operation-name": "findById", "tags": [ "DocumentCategoryController" ], "responses": { "200": { "description": "DocumentCategory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCategoryWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCategory.Filter" } } } } ], "operationId": "DocumentCategoryController.findById" }, "delete": { "x-controller-name": "DocumentCategoryController", "x-operation-name": "deleteById", "tags": [ "DocumentCategoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DocumentCategory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DocumentCategoryController.deleteById" } }, "/document-categories": { "post": { "x-controller-name": "DocumentCategoryController", "x-operation-name": "create", "tags": [ "DocumentCategoryController" ], "responses": { "200": { "description": "DocumentCategory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCategory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDocumentCategory" } } } }, "operationId": "DocumentCategoryController.create" }, "get": { "x-controller-name": "DocumentCategoryController", "x-operation-name": "find", "tags": [ "DocumentCategoryController" ], "responses": { "200": { "description": "Array of DocumentCategory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentCategoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCategory.Filter1" } } } } ], "operationId": "DocumentCategoryController.find" } }, "/document-sends/can-manage": { "get": { "x-controller-name": "DocumentSendsController", "x-operation-name": "canManage", "tags": [ "DocumentSendsController" ], "responses": { "200": { "description": "Whether the current user may manage (send/fetch) document sends, whether they hold an affiliate doc-sender capability (board #2010), and which document types they may send", "content": { "application/json": { "schema": { "type": "object", "properties": { "canManage": { "type": "boolean" }, "canSendClientDocuments": { "type": "boolean" }, "allowedDocumentTypes": { "type": "array", "items": { "type": "string" } } } } } } } }, "operationId": "DocumentSendsController.canManage" } }, "/document-sends/count": { "get": { "x-controller-name": "DocumentSendsController", "x-operation-name": "count", "tags": [ "DocumentSendsController" ], "responses": { "200": { "description": "Count of document sends visible to the caller (same scope rules as find)", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DocumentSend.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DocumentSendsController.count" } }, "/document-sends/mine": { "get": { "x-controller-name": "DocumentSendsController", "x-operation-name": "findMine", "tags": [ "DocumentSendsController" ], "responses": { "200": { "description": "Array of DocumentSend model instances for the caller's own companies", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSendWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSend.Filter" } } } } ], "operationId": "DocumentSendsController.findMine" } }, "/document-sends/{id}/recipients": { "patch": { "x-controller-name": "DocumentSendsController", "x-operation-name": "updateRecipientsById", "tags": [ "DocumentSendsController" ], "responses": { "200": { "description": "DocumentSend recipients PATCH success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSend" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sentToEmail": { "type": "string" }, "ccEmails": { "type": "array", "items": { "type": "string" } } } } } }, "x-parameter-index": 1 }, "operationId": "DocumentSendsController.updateRecipientsById" } }, "/document-sends/{id}/sign-link": { "get": { "x-controller-name": "DocumentSendsController", "x-operation-name": "getMySignLink", "tags": [ "DocumentSendsController" ], "responses": { "200": { "description": "documentSign magic-link code for an outstanding own-company send", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DocumentSendsController.getMySignLink" } }, "/document-sends/{id}/signed-pdf": { "get": { "x-controller-name": "DocumentSendsController", "x-operation-name": "downloadMySignedPdf", "tags": [ "DocumentSendsController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DocumentSendsController.downloadMySignedPdf" } }, "/document-sends/{id}": { "patch": { "x-controller-name": "DocumentSendsController", "x-operation-name": "updateStatusById", "tags": [ "DocumentSendsController" ], "responses": { "200": { "description": "DocumentSend PATCH success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSend" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string" }, "override": { "type": "boolean" }, "voidReason": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "DocumentSendsController.updateStatusById" }, "get": { "x-controller-name": "DocumentSendsController", "x-operation-name": "findById", "tags": [ "DocumentSendsController" ], "responses": { "200": { "description": "DocumentSend model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSendWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DocumentSendsController.findById" }, "delete": { "x-controller-name": "DocumentSendsController", "x-operation-name": "softDeleteById", "tags": [ "DocumentSendsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DocumentSend soft-deleted" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DocumentSendsController.softDeleteById" } }, "/document-sends": { "post": { "x-controller-name": "DocumentSendsController", "x-operation-name": "create", "tags": [ "DocumentSendsController" ], "responses": { "200": { "description": "DocumentSend model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSend" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId", "documentType" ], "properties": { "companyId": { "type": "number" }, "documentType": { "type": "string" }, "sentToEmail": { "type": "string" }, "ccEmails": { "type": "array", "items": { "type": "string" } }, "signedContractId": { "type": "number" }, "notes": { "type": "string" }, "status": { "type": "string" } } } } } }, "operationId": "DocumentSendsController.create" }, "get": { "x-controller-name": "DocumentSendsController", "x-operation-name": "find", "tags": [ "DocumentSendsController" ], "responses": { "200": { "description": "Array of DocumentSend model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSendWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSend.Filter" } } } } ], "operationId": "DocumentSendsController.find" } }, "/document-sync/automatch/apply": { "post": { "x-controller-name": "DocumentSyncController", "x-operation-name": "applyAutomatch", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-mapping link results" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "provider", "mappings" ], "properties": { "provider": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object", "required": [ "folderId", "folderName", "companyId" ], "properties": { "folderId": { "type": "string" }, "folderName": { "type": "string" }, "companyId": { "type": "number" } } } } } } } } }, "operationId": "DocumentSyncController.applyAutomatch" } }, "/document-sync/designation-suggestions": { "get": { "x-controller-name": "DocumentSyncController", "x-operation-name": "designationSuggestions", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Suggested documentType designations" } } } } }, "parameters": [ { "name": "afterId", "in": "query", "schema": { "type": "number" } } ], "operationId": "DocumentSyncController.designationSuggestions" } }, "/document-sync/designations/apply": { "post": { "x-controller-name": "DocumentSyncController", "x-operation-name": "applyDesignations", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-document designation results" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "documentId", "documentType" ], "properties": { "documentId": { "type": "number" }, "documentType": { "type": "string" } } } } } } } } }, "operationId": "DocumentSyncController.applyDesignations" } }, "/document-sync/files/import": { "post": { "x-controller-name": "DocumentSyncController", "x-operation-name": "importFile", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Import result" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "provider", "fileId" ], "properties": { "provider": { "type": "string" }, "fileId": { "type": "string" }, "companyId": { "type": "number" }, "library": { "type": "object", "properties": { "name": { "type": "string" }, "documentCategoryId": { "type": "number" }, "userLevelIds": { "type": "array", "items": { "type": "number" } } } } } } } } }, "operationId": "DocumentSyncController.importFile" } }, "/document-sync/folders/import-to-library": { "post": { "x-controller-name": "DocumentSyncController", "x-operation-name": "importFolderToLibrary", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Import result" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "provider", "folderId" ], "properties": { "provider": { "type": "string" }, "folderId": { "type": "string" }, "library": { "type": "object", "properties": { "documentCategoryId": { "type": "number" }, "userLevelIds": { "type": "array", "items": { "type": "number" } } } } } } } } }, "operationId": "DocumentSyncController.importFolderToLibrary" } }, "/document-sync/folders/{id}/sync": { "post": { "x-controller-name": "DocumentSyncController", "x-operation-name": "syncFolder", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Sync result" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DocumentSyncController.syncFolder" } }, "/document-sync/folders/{id}": { "delete": { "x-controller-name": "DocumentSyncController", "x-operation-name": "unlinkFolder", "tags": [ "DocumentSyncController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Sync link removed (imported documents remain)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DocumentSyncController.unlinkFolder" } }, "/document-sync/folders": { "post": { "x-controller-name": "DocumentSyncController", "x-operation-name": "linkFolder", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "Created sync link", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDocumentSyncFolder" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "provider", "folderId", "folderName", "companyId" ], "properties": { "provider": { "type": "string" }, "folderId": { "type": "string" }, "folderName": { "type": "string" }, "companyId": { "type": "number" } } } } } }, "operationId": "DocumentSyncController.linkFolder" } }, "/document-sync/oauth/dropbox/callback": { "get": { "x-controller-name": "DocumentSyncOauthController", "x-operation-name": "callbackDropbox", "tags": [ "DocumentSyncOauthController" ], "responses": { "200": { "description": "Return value of DocumentSyncOauthController.callbackDropbox" } }, "parameters": [ { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "error", "in": "query", "schema": { "type": "string" } } ], "operationId": "DocumentSyncOauthController.callbackDropbox" } }, "/document-sync/oauth/dropbox/connect": { "get": { "x-controller-name": "DocumentSyncOauthController", "x-operation-name": "connectDropbox", "tags": [ "DocumentSyncOauthController" ], "responses": { "200": { "description": "Return value of DocumentSyncOauthController.connectDropbox" } }, "operationId": "DocumentSyncOauthController.connectDropbox" } }, "/document-sync/oauth/dropbox/disconnect": { "post": { "x-controller-name": "DocumentSyncOauthController", "x-operation-name": "disconnectDropbox", "tags": [ "DocumentSyncOauthController" ], "responses": { "200": { "description": "Return value of DocumentSyncOauthController.disconnectDropbox" } }, "operationId": "DocumentSyncOauthController.disconnectDropbox" } }, "/document-sync/oauth/dropbox/start": { "get": { "x-controller-name": "DocumentSyncOauthController", "x-operation-name": "startDropbox", "tags": [ "DocumentSyncOauthController" ], "responses": { "200": { "description": "Return value of DocumentSyncOauthController.startDropbox" } }, "parameters": [ { "name": "ticket", "in": "query", "schema": { "type": "string" } } ], "operationId": "DocumentSyncOauthController.startDropbox" } }, "/document-sync/oauth/google/callback": { "get": { "x-controller-name": "DocumentSyncOauthController", "x-operation-name": "callback", "tags": [ "DocumentSyncOauthController" ], "responses": { "200": { "description": "Return value of DocumentSyncOauthController.callback" } }, "parameters": [ { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "error", "in": "query", "schema": { "type": "string" } } ], "operationId": "DocumentSyncOauthController.callback" } }, "/document-sync/oauth/google/connect": { "get": { "x-controller-name": "DocumentSyncOauthController", "x-operation-name": "connect", "tags": [ "DocumentSyncOauthController" ], "responses": { "200": { "description": "Return value of DocumentSyncOauthController.connect" } }, "operationId": "DocumentSyncOauthController.connect" } }, "/document-sync/oauth/google/disconnect": { "post": { "x-controller-name": "DocumentSyncOauthController", "x-operation-name": "disconnect", "tags": [ "DocumentSyncOauthController" ], "responses": { "200": { "description": "Return value of DocumentSyncOauthController.disconnect" } }, "operationId": "DocumentSyncOauthController.disconnect" } }, "/document-sync/oauth/google/start": { "get": { "x-controller-name": "DocumentSyncOauthController", "x-operation-name": "start", "tags": [ "DocumentSyncOauthController" ], "responses": { "200": { "description": "Return value of DocumentSyncOauthController.start" } }, "parameters": [ { "name": "ticket", "in": "query", "schema": { "type": "string" } } ], "operationId": "DocumentSyncOauthController.start" } }, "/document-sync/providers": { "get": { "x-controller-name": "DocumentSyncController", "x-operation-name": "providers", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Provider connection statuses" } } } } }, "operationId": "DocumentSyncController.providers" } }, "/document-sync/{provider}/automatch": { "get": { "x-controller-name": "DocumentSyncController", "x-operation-name": "automatchFolders", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Suggested folder→company mappings" } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DocumentSyncController.automatchFolders" } }, "/document-sync/{provider}/browse": { "get": { "x-controller-name": "DocumentSyncController", "x-operation-name": "browseFolder", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Subfolders + files one level down" } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "folderId", "in": "query", "schema": { "type": "string" } } ], "operationId": "DocumentSyncController.browseFolder" } }, "/document-sync/{provider}/files/download": { "get": { "x-controller-name": "DocumentSyncController", "x-operation-name": "downloadProviderFile", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "fileId", "in": "query", "schema": { "type": "string" } } ], "operationId": "DocumentSyncController.downloadProviderFile" } }, "/document-sync/{provider}/folders": { "get": { "x-controller-name": "DocumentSyncController", "x-operation-name": "listFolders", "tags": [ "DocumentSyncController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Provider folders + link/sync status" } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DocumentSyncController.listFolders" } }, "/document-types/count": { "get": { "x-controller-name": "DocumentTypeController", "x-operation-name": "count", "tags": [ "DocumentTypeController" ], "responses": { "200": { "description": "DocumentType model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DocumentType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DocumentTypeController.count" } }, "/document-types/{id}": { "put": { "x-controller-name": "DocumentTypeController", "x-operation-name": "replaceById", "tags": [ "DocumentTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DocumentType PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } }, "x-parameter-index": 1 }, "operationId": "DocumentTypeController.replaceById" }, "patch": { "x-controller-name": "DocumentTypeController", "x-operation-name": "updateById", "tags": [ "DocumentTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DocumentType PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypePartial" } } }, "x-parameter-index": 1 }, "operationId": "DocumentTypeController.updateById" }, "get": { "x-controller-name": "DocumentTypeController", "x-operation-name": "findById", "tags": [ "DocumentTypeController" ], "responses": { "200": { "description": "DocumentType model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypeWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType.Filter" } } } } ], "operationId": "DocumentTypeController.findById" }, "delete": { "x-controller-name": "DocumentTypeController", "x-operation-name": "deleteById", "tags": [ "DocumentTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DocumentType DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DocumentTypeController.deleteById" } }, "/document-types": { "post": { "x-controller-name": "DocumentTypeController", "x-operation-name": "create", "tags": [ "DocumentTypeController" ], "responses": { "200": { "description": "DocumentType model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDocumentType" } } } }, "operationId": "DocumentTypeController.create" }, "patch": { "x-controller-name": "DocumentTypeController", "x-operation-name": "updateAll", "tags": [ "DocumentTypeController" ], "responses": { "200": { "description": "DocumentType PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DocumentType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypePartial" } } } }, "operationId": "DocumentTypeController.updateAll" }, "get": { "x-controller-name": "DocumentTypeController", "x-operation-name": "find", "tags": [ "DocumentTypeController" ], "responses": { "200": { "description": "Array of DocumentType model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentTypeWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType.Filter1" } } } } ], "operationId": "DocumentTypeController.find" } }, "/documents/count": { "get": { "x-controller-name": "DocumentsController", "x-operation-name": "count", "tags": [ "DocumentsController" ], "responses": { "200": { "description": "Document model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Document.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DocumentsController.count" } }, "/documents/visible-to-me": { "get": { "x-controller-name": "DocumentsController", "x-operation-name": "visibleToMe", "tags": [ "DocumentsController" ], "responses": { "200": { "description": "Documents visible to the current user via their user levels", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentWithRelations" } } } } } }, "operationId": "DocumentsController.visibleToMe" } }, "/documents/{id}": { "patch": { "x-controller-name": "DocumentsController", "x-operation-name": "updateById", "tags": [ "DocumentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Document PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileUploadId": { "type": "number" }, "thumbnailFileUploadId": { "type": "number", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string" }, "documentCategoryId": { "type": "number" }, "userLevelIds": { "type": "array", "items": { "type": "number" } } } } } }, "x-parameter-index": 1 }, "operationId": "DocumentsController.updateById" }, "get": { "x-controller-name": "DocumentsController", "x-operation-name": "findById", "tags": [ "DocumentsController" ], "responses": { "200": { "description": "Document model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DocumentsController.findById" }, "delete": { "x-controller-name": "DocumentsController", "x-operation-name": "deleteById", "tags": [ "DocumentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Document DELETE success (soft)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DocumentsController.deleteById" } }, "/documents": { "post": { "x-controller-name": "DocumentsController", "x-operation-name": "create", "tags": [ "DocumentsController" ], "responses": { "200": { "description": "Document model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileUploadId": { "type": "number" }, "thumbnailFileUploadId": { "type": "number", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string" }, "documentCategoryId": { "type": "number" }, "userLevelIds": { "type": "array", "items": { "type": "number" } } } } } } }, "operationId": "DocumentsController.create" }, "get": { "x-controller-name": "DocumentsController", "x-operation-name": "find", "tags": [ "DocumentsController" ], "responses": { "200": { "description": "Array of Document model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document.Filter" } } } }, { "name": "userLevelId", "in": "query", "schema": { "type": "number" } } ], "operationId": "DocumentsController.find" } }, "/education-content/mine": { "get": { "x-controller-name": "EducationContentController", "x-operation-name": "mine", "tags": [ "EducationContentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The caller's education content" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EducationContentController.mine" } }, "/education-content/{id}": { "patch": { "x-controller-name": "EducationContentAdminController", "x-operation-name": "updateById", "tags": [ "EducationContentAdminController" ], "responses": { "200": { "description": "The updated education content row", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "kind": { "type": "string" }, "body": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "sortOrder": { "type": "number" }, "language": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean" }, "scheduledAt": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "EducationContentAdminController.updateById" }, "delete": { "x-controller-name": "EducationContentAdminController", "x-operation-name": "deleteById", "tags": [ "EducationContentAdminController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Education content DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EducationContentAdminController.deleteById" } }, "/education-engagement/mark": { "post": { "x-controller-name": "EducationEngagementController", "x-operation-name": "mark", "tags": [ "EducationEngagementController" ], "responses": { "200": { "description": "The appended education engagement event", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationEngagementEvent" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId", "sessionId", "externalId", "state" ], "properties": { "companyId": { "type": "number" }, "sessionId": { "type": "number" }, "externalId": { "type": "string", "maxLength": 191 }, "personName": { "type": "string", "maxLength": 255 }, "state": { "type": "string", "maxLength": 32, "enum": [ "registered", "attended", "missed" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "note": { "type": "string", "maxLength": 1000 } }, "additionalProperties": false } } } }, "operationId": "EducationEngagementController.mark" } }, "/education-engagement": { "get": { "x-controller-name": "EducationEngagementController", "x-operation-name": "find", "tags": [ "EducationEngagementController" ], "responses": { "200": { "description": "Education engagement events for one company (optionally one session)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EducationEngagementEvent" } } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } }, { "name": "sessionId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EducationEngagementController.find" } }, "/education-media-files": { "post": { "x-controller-name": "EducationMediaFilesController", "x-operation-name": "upload", "tags": [ "EducationMediaFilesController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array" } } }, "description": "Stored education media file metadata (one-element array)." } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "EducationMediaFilesController.upload" } }, "/email-connections/callback": { "get": { "x-controller-name": "EmailConnectionsController", "x-operation-name": "callback", "tags": [ "EmailConnectionsController" ], "responses": { "200": { "description": "Return value of EmailConnectionsController.callback" } }, "parameters": [ { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "error", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailConnectionsController.callback" } }, "/email-connections/connect": { "get": { "x-controller-name": "EmailConnectionsController", "x-operation-name": "connect", "tags": [ "EmailConnectionsController" ], "responses": { "200": { "description": "Return value of EmailConnectionsController.connect" } }, "operationId": "EmailConnectionsController.connect" } }, "/email-connections/disconnect": { "post": { "x-controller-name": "EmailConnectionsController", "x-operation-name": "disconnect", "tags": [ "EmailConnectionsController" ], "responses": { "200": { "description": "Return value of EmailConnectionsController.disconnect" } }, "operationId": "EmailConnectionsController.disconnect" } }, "/email-connections/me": { "get": { "x-controller-name": "EmailConnectionsController", "x-operation-name": "me", "tags": [ "EmailConnectionsController" ], "responses": { "200": { "description": "Return value of EmailConnectionsController.me" } }, "operationId": "EmailConnectionsController.me" } }, "/email-connections/start": { "get": { "x-controller-name": "EmailConnectionsController", "x-operation-name": "start", "tags": [ "EmailConnectionsController" ], "responses": { "200": { "description": "Return value of EmailConnectionsController.start" } }, "parameters": [ { "name": "ticket", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailConnectionsController.start" } }, "/email-footer/preview": { "get": { "x-controller-name": "EmailFooterController", "x-operation-name": "preview", "tags": [ "EmailFooterController" ], "responses": { "200": { "description": "Return value of EmailFooterController.preview" } }, "parameters": [ { "name": "variant", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailFooterController.preview" } }, "/email-messages/folders": { "get": { "x-controller-name": "EmailMessagesController", "x-operation-name": "listFolders", "tags": [ "EmailMessagesController" ], "responses": { "200": { "description": "Return value of EmailMessagesController.listFolders" } }, "operationId": "EmailMessagesController.listFolders" } }, "/email-messages/rewrite-draft": { "post": { "x-controller-name": "EmailComposeAssistController", "x-operation-name": "rewriteDraft", "tags": [ "EmailComposeAssistController" ], "responses": { "200": { "description": "Plain-text rewrite of the caller's draft in the requested tone", "content": { "application/json": { "schema": { "type": "object", "properties": { "draft": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailComposeRewriteRequest" } } } }, "operationId": "EmailComposeAssistController.rewriteDraft" } }, "/email-messages/send": { "post": { "x-controller-name": "EmailSendController", "x-operation-name": "send", "tags": [ "EmailSendController" ], "responses": { "200": { "description": "Return value of EmailSendController.send" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "to", "subject", "body" ], "properties": { "to": { "type": "array", "items": { "type": "string" } }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "subject": { "type": "string" }, "body": { "type": "string" }, "bodyHtml": { "type": "string" }, "replyToMessageId": { "type": "number" }, "sendAt": { "type": "string" }, "trackOpens": { "type": "boolean" }, "companyId": { "type": "number" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "filename": { "type": "string" }, "mimeType": { "type": "string" }, "dataBase64": { "type": "string" } } } } } } } } }, "operationId": "EmailSendController.send" } }, "/email-messages/{id}/action": { "post": { "x-controller-name": "EmailMessagesController", "x-operation-name": "performAction", "tags": [ "EmailMessagesController" ], "responses": { "200": { "description": "Return value of EmailMessagesController.performAction" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "EmailMessagesController.performAction" } }, "/email-messages/{id}/assign-company": { "post": { "x-controller-name": "EmailMessagesController", "x-operation-name": "assignCompany", "tags": [ "EmailMessagesController" ], "responses": { "200": { "description": "Return value of EmailMessagesController.assignCompany" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "EmailMessagesController.assignCompany" } }, "/email-messages/{id}/attachments/{attachmentId}/convert": { "post": { "x-controller-name": "EmailAttachmentsController", "x-operation-name": "convert", "tags": [ "EmailAttachmentsController" ], "responses": { "200": { "description": "Return value of EmailAttachmentsController.convert" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "attachmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" }, "kind": { "type": "string" }, "notes": { "type": "string" } } } } }, "x-parameter-index": 2 }, "operationId": "EmailAttachmentsController.convert" } }, "/email-messages/{id}/attachments/{attachmentId}/download": { "get": { "x-controller-name": "EmailAttachmentsController", "x-operation-name": "download", "tags": [ "EmailAttachmentsController" ], "responses": { "200": { "description": "Return value of EmailAttachmentsController.download" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "attachmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "EmailAttachmentsController.download" } }, "/email-messages/{id}/draft-reply": { "post": { "x-controller-name": "EmailComposeAssistController", "x-operation-name": "draftReply", "tags": [ "EmailComposeAssistController" ], "responses": { "200": { "description": "Plain-text reply draft to the given message, grounded in its thread (own mailbox only)", "content": { "application/json": { "schema": { "type": "object", "properties": { "draft": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailComposeAssistController.draftReply" } }, "/email-messages/{id}/move": { "post": { "x-controller-name": "EmailMessagesController", "x-operation-name": "moveToFolder", "tags": [ "EmailMessagesController" ], "responses": { "200": { "description": "Return value of EmailMessagesController.moveToFolder" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "labelId" ], "properties": { "labelId": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "EmailMessagesController.moveToFolder" } }, "/email-messages/{id}/summarize-thread": { "post": { "x-controller-name": "EmailThreadSummaryController", "x-operation-name": "summarizeThread", "tags": [ "EmailThreadSummaryController" ], "responses": { "200": { "description": "Markdown summary of the message's thread (own mailbox only)", "content": { "application/json": { "schema": { "type": "object", "properties": { "summary": { "type": "string" }, "messageCount": { "type": "number" }, "truncated": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailThreadSummaryController.summarizeThread" } }, "/email-messages/{id}/unassign-company": { "post": { "x-controller-name": "EmailMessagesController", "x-operation-name": "unassignCompany", "tags": [ "EmailMessagesController" ], "responses": { "200": { "description": "Return value of EmailMessagesController.unassignCompany" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "EmailMessagesController.unassignCompany" } }, "/email-messages/{id}": { "get": { "x-controller-name": "EmailMessagesController", "x-operation-name": "findById", "tags": [ "EmailMessagesController" ], "responses": { "200": { "description": "Return value of EmailMessagesController.findById" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailMessagesController.findById" } }, "/email-messages": { "get": { "x-controller-name": "EmailMessagesController", "x-operation-name": "findMine", "tags": [ "EmailMessagesController" ], "responses": { "200": { "description": "Return value of EmailMessagesController.findMine" } }, "parameters": [ { "name": "folder", "in": "query", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "labelId", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMessagesController.findMine" } }, "/email-recipients": { "get": { "x-controller-name": "EmailRecipientsController", "x-operation-name": "search", "tags": [ "EmailRecipientsController" ], "responses": { "200": { "description": "Return value of EmailRecipientsController.search" } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailRecipientsController.search" } }, "/email-suppression/{address}/clear": { "patch": { "x-controller-name": "EmailSuppressionController", "x-operation-name": "clear", "tags": [ "EmailSuppressionController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Suppression cleared" } } } } }, "parameters": [ { "name": "address", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false, "x-parameter-index": 1 }, "operationId": "EmailSuppressionController.clear" } }, "/email-suppression/{address}": { "get": { "x-controller-name": "EmailSuppressionController", "x-operation-name": "findByAddress", "tags": [ "EmailSuppressionController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Suppression state for an address" } } } } }, "parameters": [ { "name": "address", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "EmailSuppressionController.findByAddress" } }, "/email-templates/{id}": { "patch": { "x-controller-name": "EmailTemplatesController", "x-operation-name": "updateById", "tags": [ "EmailTemplatesController" ], "responses": { "200": { "description": "Update an email template — super-user: any; others: own-company rows only", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplate" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmailTemplate" } } }, "x-parameter-index": 1 }, "operationId": "EmailTemplatesController.updateById" }, "delete": { "x-controller-name": "EmailTemplatesController", "x-operation-name": "deleteById", "tags": [ "EmailTemplatesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete an email template — super-user: any; others: own-company rows only" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailTemplatesController.deleteById" } }, "/email-templates": { "post": { "x-controller-name": "EmailTemplatesController", "x-operation-name": "create", "tags": [ "EmailTemplatesController" ], "responses": { "200": { "description": "Create an email template — super-user: any/shared; others: own-company only", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplate" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewEmailTemplate" } } } }, "operationId": "EmailTemplatesController.create" }, "get": { "x-controller-name": "EmailTemplatesController", "x-operation-name": "find", "tags": [ "EmailTemplatesController" ], "responses": { "200": { "description": "List email templates (shared + own-company rows)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTemplate" } } } } } }, "operationId": "EmailTemplatesController.find" } }, "/employee-activity-events": { "get": { "x-controller-name": "EmployeeActivityEventController", "x-operation-name": "find", "tags": [ "EmployeeActivityEventController" ], "responses": { "200": { "description": "Array of EmployeeActivityEvent instances, self-scoped unless SuperUser", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeActivityEvent" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeActivityEvent.Filter" } } } } ], "operationId": "EmployeeActivityEventController.find" } }, "/employee-change-events/count": { "get": { "x-controller-name": "EmployeeChangeEventController", "x-operation-name": "count", "tags": [ "EmployeeChangeEventController" ], "responses": { "200": { "description": "EmployeeChangeEvent model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "EmployeeChangeEvent.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "EmployeeChangeEventController.count" } }, "/employee-change-events/{id}": { "put": { "x-controller-name": "EmployeeChangeEventController", "x-operation-name": "replaceById", "tags": [ "EmployeeChangeEventController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "EmployeeChangeEvent PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeChangeEvent" } } }, "x-parameter-index": 1 }, "operationId": "EmployeeChangeEventController.replaceById" }, "patch": { "x-controller-name": "EmployeeChangeEventController", "x-operation-name": "updateById", "tags": [ "EmployeeChangeEventController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "EmployeeChangeEvent PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeChangeEventPartial" } } }, "x-parameter-index": 1 }, "operationId": "EmployeeChangeEventController.updateById" }, "get": { "x-controller-name": "EmployeeChangeEventController", "x-operation-name": "findById", "tags": [ "EmployeeChangeEventController" ], "responses": { "200": { "description": "EmployeeChangeEvent model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeChangeEventWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeChangeEvent.Filter" } } } } ], "operationId": "EmployeeChangeEventController.findById" }, "delete": { "x-controller-name": "EmployeeChangeEventController", "x-operation-name": "deleteById", "tags": [ "EmployeeChangeEventController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "EmployeeChangeEvent DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployeeChangeEventController.deleteById" } }, "/employee-change-events": { "post": { "x-controller-name": "EmployeeChangeEventController", "x-operation-name": "create", "tags": [ "EmployeeChangeEventController" ], "responses": { "200": { "description": "EmployeeChangeEvent model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeChangeEvent" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewEmployeeChangeEvent" } } } }, "operationId": "EmployeeChangeEventController.create" }, "patch": { "x-controller-name": "EmployeeChangeEventController", "x-operation-name": "updateAll", "tags": [ "EmployeeChangeEventController" ], "responses": { "200": { "description": "EmployeeChangeEvent PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "EmployeeChangeEvent.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeChangeEventPartial" } } } }, "operationId": "EmployeeChangeEventController.updateAll" }, "get": { "x-controller-name": "EmployeeChangeEventController", "x-operation-name": "find", "tags": [ "EmployeeChangeEventController" ], "responses": { "200": { "description": "Array of EmployeeChangeEvent model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeChangeEventWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeChangeEvent.Filter1" } } } } ], "operationId": "EmployeeChangeEventController.find" } }, "/employee-change-requests/{id}": { "patch": { "x-controller-name": "EmployeeChangeRequestsController", "x-operation-name": "review", "tags": [ "EmployeeChangeRequestsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The updated request" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string" }, "resolutionNote": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "EmployeeChangeRequestsController.review" } }, "/employee-documents/{id}/download": { "get": { "x-controller-name": "EmployeeDocumentsController", "x-operation-name": "downloadEmployeeDocument", "tags": [ "EmployeeDocumentsController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployeeDocumentsController.downloadEmployeeDocument" } }, "/employer-groups/{groupId}/attach": { "post": { "x-controller-name": "EmployerGroupController", "x-operation-name": "attach", "tags": [ "EmployerGroupController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The updated employer group" } } } } }, "parameters": [ { "name": "groupId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "EmployerGroupController.attach" } }, "/employer-groups/{groupId}/detach": { "post": { "x-controller-name": "EmployerGroupController", "x-operation-name": "detach", "tags": [ "EmployerGroupController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The updated employer group" } } } } }, "parameters": [ { "name": "groupId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "EmployerGroupController.detach" } }, "/employer-groups/{groupId}/lead": { "post": { "x-controller-name": "EmployerGroupController", "x-operation-name": "setLead", "tags": [ "EmployerGroupController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The updated employer group" } } } } }, "parameters": [ { "name": "groupId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "EmployerGroupController.setLead" } }, "/employer-groups/{groupId}": { "get": { "x-controller-name": "EmployerGroupController", "x-operation-name": "findById", "tags": [ "EmployerGroupController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "An employer group and its entities" } } } } }, "parameters": [ { "name": "groupId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployerGroupController.findById" } }, "/employer-groups": { "post": { "x-controller-name": "EmployerGroupController", "x-operation-name": "create", "tags": [ "EmployerGroupController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The created employer group" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "leadCompanyId" ], "properties": { "name": { "type": "string" }, "leadCompanyId": { "type": "number" }, "companyIds": { "type": "array", "items": { "type": "number" } } } } } } }, "operationId": "EmployerGroupController.create" } }, "/field-rule-groups/count": { "get": { "x-controller-name": "FieldRuleGroupsController", "x-operation-name": "count", "tags": [ "FieldRuleGroupsController" ], "responses": { "200": { "description": "FieldRuleGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FieldRuleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FieldRuleGroupsController.count" } }, "/field-rule-groups/{id}": { "put": { "x-controller-name": "FieldRuleGroupsController", "x-operation-name": "replaceById", "tags": [ "FieldRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FieldRuleGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldRuleGroups" } } }, "x-parameter-index": 1 }, "operationId": "FieldRuleGroupsController.replaceById" }, "patch": { "x-controller-name": "FieldRuleGroupsController", "x-operation-name": "updateById", "tags": [ "FieldRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FieldRuleGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldRuleGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "FieldRuleGroupsController.updateById" }, "get": { "x-controller-name": "FieldRuleGroupsController", "x-operation-name": "findById", "tags": [ "FieldRuleGroupsController" ], "responses": { "200": { "description": "FieldRuleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldRuleGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldRuleGroups.Filter" } } } } ], "operationId": "FieldRuleGroupsController.findById" }, "delete": { "x-controller-name": "FieldRuleGroupsController", "x-operation-name": "deleteById", "tags": [ "FieldRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FieldRuleGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FieldRuleGroupsController.deleteById" } }, "/field-rule-groups": { "post": { "x-controller-name": "FieldRuleGroupsController", "x-operation-name": "create", "tags": [ "FieldRuleGroupsController" ], "responses": { "200": { "description": "FieldRuleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldRuleGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewFieldRuleGroups" } } } }, "operationId": "FieldRuleGroupsController.create" }, "patch": { "x-controller-name": "FieldRuleGroupsController", "x-operation-name": "updateAll", "tags": [ "FieldRuleGroupsController" ], "responses": { "200": { "description": "FieldRuleGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FieldRuleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldRuleGroupsPartial" } } } }, "operationId": "FieldRuleGroupsController.updateAll" }, "get": { "x-controller-name": "FieldRuleGroupsController", "x-operation-name": "find", "tags": [ "FieldRuleGroupsController" ], "responses": { "200": { "description": "Array of FieldRuleGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldRuleGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldRuleGroups.Filter1" } } } } ], "operationId": "FieldRuleGroupsController.find" } }, "/file-uploads/count": { "get": { "x-controller-name": "FileUploadsController", "x-operation-name": "count", "tags": [ "FileUploadsController" ], "responses": { "200": { "description": "FileUploads model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FileUploads.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "showHidden", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "FileUploadsController.count" } }, "/file-uploads/paperwork-status": { "get": { "x-controller-name": "FileUploadsController", "x-operation-name": "paperworkStatus", "tags": [ "FileUploadsController" ], "responses": { "200": { "description": "Distinct companyIds (within the caller scope) that have a W-9 / signed contract on file", "content": { "application/json": { "schema": { "type": "object", "properties": { "companyIdsWithW9": { "type": "array", "items": { "type": "number" } }, "companyIdsWithContract": { "type": "array", "items": { "type": "number" } } } } } } } }, "operationId": "FileUploadsController.paperworkStatus" } }, "/file-uploads/w9": { "post": { "x-controller-name": "FileUploadsController", "x-operation-name": "uploadW9", "tags": [ "FileUploadsController" ], "responses": { "200": { "description": "Uploaded W-9 file_uploads row (stored under a secure key)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploads" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "FileUploadsController.uploadW9" } }, "/file-uploads/zip": { "post": { "x-controller-name": "FileUploadsController", "x-operation-name": "zipFiles", "tags": [ "FileUploadsController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "operationId": "FileUploadsController.zipFiles" } }, "/file-uploads/{id}/document-type": { "get": { "x-controller-name": "FileUploadsDocumentTypeController", "x-operation-name": "getDocumentType", "tags": [ "FileUploadsDocumentTypeController" ], "responses": { "200": { "description": "DocumentType belonging to FileUploads", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FileUploadsDocumentTypeController.getDocumentType" } }, "/file-uploads/{id}/download": { "get": { "x-controller-name": "FileUploadsController", "x-operation-name": "downloadById", "tags": [ "FileUploadsController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FileUploadsController.downloadById" } }, "/file-uploads/{id}": { "put": { "x-controller-name": "FileUploadsController", "x-operation-name": "replaceById", "tags": [ "FileUploadsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FileUploads PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploads" } } }, "x-parameter-index": 1 }, "operationId": "FileUploadsController.replaceById" }, "patch": { "x-controller-name": "FileUploadsController", "x-operation-name": "updateById", "tags": [ "FileUploadsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FileUploads PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadsPartial" } } }, "x-parameter-index": 1 }, "operationId": "FileUploadsController.updateById" }, "get": { "x-controller-name": "FileUploadsController", "x-operation-name": "findById", "tags": [ "FileUploadsController" ], "responses": { "200": { "description": "FileUploads model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploads.Filter" } } } } ], "operationId": "FileUploadsController.findById" }, "delete": { "x-controller-name": "FileUploadsController", "x-operation-name": "deleteById", "tags": [ "FileUploadsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FileUploads DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FileUploadsController.deleteById" } }, "/file-uploads": { "post": { "x-controller-name": "FileUploadsController", "x-operation-name": "create", "tags": [ "FileUploadsController" ], "responses": { "200": { "description": "FileUploads model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploads" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewFileUploads" } } } }, "operationId": "FileUploadsController.create" }, "get": { "x-controller-name": "FileUploadsController", "x-operation-name": "find", "tags": [ "FileUploadsController" ], "responses": { "200": { "description": "Array of FileUploads model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileUploadsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploads.Filter1" } } } }, { "name": "showHidden", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "FileUploadsController.find" } }, "/files/{filename}": { "get": { "x-controller-name": "FileDownloadController", "x-operation-name": "downloadFile", "tags": [ "FileDownloadController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "filename", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "w", "in": "query", "schema": { "type": "number" } } ], "operationId": "FileDownloadController.downloadFile" } }, "/files": { "post": { "x-controller-name": "FileUploadController", "x-operation-name": "fileUpload", "tags": [ "FileUploadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "FileUploadController.fileUpload" }, "patch": { "x-controller-name": "FilesController", "x-operation-name": "updateAll", "tags": [ "FilesController" ], "responses": { "200": { "description": "Files PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Files.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesPartial" } } } }, "operationId": "FilesController.updateAll" }, "get": { "x-controller-name": "FileDownloadController", "x-operation-name": "listFiles", "tags": [ "FileDownloadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "description": "A list of files" } }, "operationId": "FileDownloadController.listFiles" } }, "/finch/connect-session": { "post": { "x-controller-name": "FinchController", "x-operation-name": "createSession", "tags": [ "FinchController" ], "responses": {}, "requestBody": { "content": { "application/json": { "schema": {} } } }, "operationId": "FinchController.createSession" } }, "/finch/link": { "post": { "x-controller-name": "FinchController", "x-operation-name": "create", "tags": [ "FinchController" ], "responses": {}, "requestBody": { "content": { "application/json": { "schema": {} } } }, "operationId": "FinchController.create" } }, "/finch/webhook": { "post": { "x-controller-name": "FinchWebhookController", "x-operation-name": "handle", "tags": [ "FinchWebhookController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Event acknowledged" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "FinchWebhookController.handle" } }, "/get-2848-1": { "post": { "x-controller-name": "Create2848Controller", "x-operation-name": "get2848", "tags": [ "Create2848Controller" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "processflowId": { "type": "number" } } } } } }, "operationId": "Create2848Controller.get2848" } }, "/get-2848-2": { "post": { "x-controller-name": "Create2848Controller", "x-operation-name": "get2848Page2", "tags": [ "Create2848Controller" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "processflowId": { "type": "number" } } } } } }, "operationId": "Create2848Controller.get2848Page2" } }, "/get-911-1": { "post": { "x-controller-name": "Create2848Controller", "x-operation-name": "get911Page1", "tags": [ "Create2848Controller" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "processflowId": { "type": "number" } } } } } }, "operationId": "Create2848Controller.get911Page1" } }, "/get-911-2": { "post": { "x-controller-name": "Create2848Controller", "x-operation-name": "get911Page2", "tags": [ "Create2848Controller" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "processflowId": { "type": "number" } } } } } }, "operationId": "Create2848Controller.get911Page2" } }, "/get-911-3": { "post": { "x-controller-name": "Create2848Controller", "x-operation-name": "get911Page3", "tags": [ "Create2848Controller" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "processflowId": { "type": "number" } } } } } }, "operationId": "Create2848Controller.get911Page3" } }, "/get-911-4": { "post": { "x-controller-name": "Create2848Controller", "x-operation-name": "get911Page4", "tags": [ "Create2848Controller" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "processflowId": { "type": "number" } } } } } }, "operationId": "Create2848Controller.get911Page4" } }, "/get-aggregate-sentence": { "post": { "x-controller-name": "QualificationForRevenueReductionController", "x-operation-name": "getAggregateSentence", "tags": [ "QualificationForRevenueReductionController" ], "responses": { "200": { "description": "Qualification for revenue reduction with aggregate companies", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "companyGroup": { "type": "number" } } } } } }, "operationId": "QualificationForRevenueReductionController.getAggregateSentence" } }, "/gmail/pubsub": { "post": { "x-controller-name": "GmailPubsubController", "x-operation-name": "receive", "tags": [ "GmailPubsubController" ], "responses": { "200": { "description": "Return value of GmailPubsubController.receive" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "GmailPubsubController.receive" } }, "/help/ask": { "post": { "x-controller-name": "HelpAskController", "x-operation-name": "ask", "tags": [ "HelpAskController" ], "responses": { "200": { "description": "Answer to a help question, grounded in the guide corpus", "content": { "application/json": { "schema": { "type": "object", "properties": { "answer": { "type": "string" }, "citedSlugs": { "type": "array", "items": { "type": "string" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpAskRequest" } } } }, "operationId": "HelpAskController.ask" } }, "/higgs-outputs/import": { "post": { "x-controller-name": "HiggsOutputController", "x-operation-name": "import", "tags": [ "HiggsOutputController" ], "responses": { "200": { "description": "Fetches the source URL server-side into S3 and returns the created row", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sourceUrl", "title" ], "properties": { "sourceUrl": { "type": "string" }, "title": { "type": "string" } } } } }, "required": true }, "operationId": "HiggsOutputController.import" } }, "/higgs-outputs/sync": { "post": { "x-controller-name": "HiggsOutputController", "x-operation-name": "sync", "tags": [ "HiggsOutputController" ], "responses": { "200": { "description": "Plans the sync, starts the copying in the background, returns the plan", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "HiggsOutputController.sync" } }, "/higgs-outputs/{id}/stream": { "get": { "x-controller-name": "HiggsOutputController", "x-operation-name": "stream", "tags": [ "HiggsOutputController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "HiggsOutputController.stream" }, "head": { "x-controller-name": "HiggsOutputController", "x-operation-name": "streamHead", "tags": [ "HiggsOutputController" ], "responses": { "200": { "description": "Return value of HiggsOutputController.streamHead" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "HiggsOutputController.streamHead" } }, "/higgs-outputs/{id}/thumbnail": { "get": { "x-controller-name": "HiggsOutputController", "x-operation-name": "thumbnail", "tags": [ "HiggsOutputController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "HiggsOutputController.thumbnail" } }, "/higgs-outputs": { "get": { "x-controller-name": "HiggsOutputController", "x-operation-name": "list", "tags": [ "HiggsOutputController" ], "responses": { "200": { "description": "Imported Higgsfield outputs, newest first (capped at 200)", "content": { "application/json": { "schema": { "type": "array" } } } } }, "operationId": "HiggsOutputController.list" } }, "/industries/count": { "get": { "x-controller-name": "IndustriesController", "x-operation-name": "count", "tags": [ "IndustriesController" ], "responses": { "200": { "description": "Industries model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Industries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "IndustriesController.count" } }, "/industries/{id}": { "put": { "x-controller-name": "IndustriesController", "x-operation-name": "replaceById", "tags": [ "IndustriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Industries PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Industries" } } }, "x-parameter-index": 1 }, "operationId": "IndustriesController.replaceById" }, "patch": { "x-controller-name": "IndustriesController", "x-operation-name": "updateById", "tags": [ "IndustriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Industries PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustriesPartial" } } }, "x-parameter-index": 1 }, "operationId": "IndustriesController.updateById" }, "get": { "x-controller-name": "IndustriesController", "x-operation-name": "findById", "tags": [ "IndustriesController" ], "responses": { "200": { "description": "Industries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustriesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Industries.Filter" } } } } ], "operationId": "IndustriesController.findById" }, "delete": { "x-controller-name": "IndustriesController", "x-operation-name": "deleteById", "tags": [ "IndustriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Industries DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "IndustriesController.deleteById" } }, "/industries": { "post": { "x-controller-name": "IndustriesController", "x-operation-name": "create", "tags": [ "IndustriesController" ], "responses": { "200": { "description": "Industries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Industries" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewIndustries" } } } }, "operationId": "IndustriesController.create" }, "patch": { "x-controller-name": "IndustriesController", "x-operation-name": "updateAll", "tags": [ "IndustriesController" ], "responses": { "200": { "description": "Industries PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Industries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustriesPartial" } } } }, "operationId": "IndustriesController.updateAll" }, "get": { "x-controller-name": "IndustriesController", "x-operation-name": "find", "tags": [ "IndustriesController" ], "responses": { "200": { "description": "Array of Industries model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndustriesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Industries.Filter1" } } } } ], "operationId": "IndustriesController.find" } }, "/industry-group-members/count": { "get": { "x-controller-name": "IndustryGroupMembersController", "x-operation-name": "count", "tags": [ "IndustryGroupMembersController" ], "responses": { "200": { "description": "IndustryGroupMembers model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "IndustryGroupMembers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "IndustryGroupMembersController.count" } }, "/industry-group-members/{id}": { "put": { "x-controller-name": "IndustryGroupMembersController", "x-operation-name": "replaceById", "tags": [ "IndustryGroupMembersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "IndustryGroupMembers PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroupMembers" } } }, "x-parameter-index": 1 }, "operationId": "IndustryGroupMembersController.replaceById" }, "patch": { "x-controller-name": "IndustryGroupMembersController", "x-operation-name": "updateById", "tags": [ "IndustryGroupMembersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "IndustryGroupMembers PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroupMembersPartial" } } }, "x-parameter-index": 1 }, "operationId": "IndustryGroupMembersController.updateById" }, "get": { "x-controller-name": "IndustryGroupMembersController", "x-operation-name": "findById", "tags": [ "IndustryGroupMembersController" ], "responses": { "200": { "description": "IndustryGroupMembers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroupMembersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroupMembers.Filter" } } } } ], "operationId": "IndustryGroupMembersController.findById" }, "delete": { "x-controller-name": "IndustryGroupMembersController", "x-operation-name": "deleteById", "tags": [ "IndustryGroupMembersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "IndustryGroupMembers DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "IndustryGroupMembersController.deleteById" } }, "/industry-group-members": { "post": { "x-controller-name": "IndustryGroupMembersController", "x-operation-name": "create", "tags": [ "IndustryGroupMembersController" ], "responses": { "200": { "description": "IndustryGroupMembers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroupMembers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewIndustryGroupMembers" } } } }, "operationId": "IndustryGroupMembersController.create" }, "patch": { "x-controller-name": "IndustryGroupMembersController", "x-operation-name": "updateAll", "tags": [ "IndustryGroupMembersController" ], "responses": { "200": { "description": "IndustryGroupMembers PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "IndustryGroupMembers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroupMembersPartial" } } } }, "operationId": "IndustryGroupMembersController.updateAll" }, "get": { "x-controller-name": "IndustryGroupMembersController", "x-operation-name": "find", "tags": [ "IndustryGroupMembersController" ], "responses": { "200": { "description": "Array of IndustryGroupMembers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndustryGroupMembersWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroupMembers.Filter1" } } } } ], "operationId": "IndustryGroupMembersController.find" } }, "/industry-groups/count": { "get": { "x-controller-name": "IndustryGroupsController", "x-operation-name": "count", "tags": [ "IndustryGroupsController" ], "responses": { "200": { "description": "IndustryGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "IndustryGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "IndustryGroupsController.count" } }, "/industry-groups/{id}": { "put": { "x-controller-name": "IndustryGroupsController", "x-operation-name": "replaceById", "tags": [ "IndustryGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "IndustryGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroups" } } }, "x-parameter-index": 1 }, "operationId": "IndustryGroupsController.replaceById" }, "patch": { "x-controller-name": "IndustryGroupsController", "x-operation-name": "updateById", "tags": [ "IndustryGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "IndustryGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "IndustryGroupsController.updateById" }, "get": { "x-controller-name": "IndustryGroupsController", "x-operation-name": "findById", "tags": [ "IndustryGroupsController" ], "responses": { "200": { "description": "IndustryGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroups.Filter" } } } } ], "operationId": "IndustryGroupsController.findById" }, "delete": { "x-controller-name": "IndustryGroupsController", "x-operation-name": "deleteById", "tags": [ "IndustryGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "IndustryGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "IndustryGroupsController.deleteById" } }, "/industry-groups": { "post": { "x-controller-name": "IndustryGroupsController", "x-operation-name": "create", "tags": [ "IndustryGroupsController" ], "responses": { "200": { "description": "IndustryGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewIndustryGroups" } } } }, "operationId": "IndustryGroupsController.create" }, "patch": { "x-controller-name": "IndustryGroupsController", "x-operation-name": "updateAll", "tags": [ "IndustryGroupsController" ], "responses": { "200": { "description": "IndustryGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "IndustryGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroupsPartial" } } } }, "operationId": "IndustryGroupsController.updateAll" }, "get": { "x-controller-name": "IndustryGroupsController", "x-operation-name": "find", "tags": [ "IndustryGroupsController" ], "responses": { "200": { "description": "Array of IndustryGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndustryGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryGroups.Filter1" } } } } ], "operationId": "IndustryGroupsController.find" } }, "/interaction-handovers/mine": { "get": { "x-controller-name": "InteractionHandoversController", "x-operation-name": "mine", "tags": [ "InteractionHandoversController" ], "responses": { "200": { "description": "The caller's handover work: `assigned` = active handovers where they are the assignee (their \"things I have to do\"); `awaitingMyReview` = awaiting_review handovers where they are the owner. Bounded (100 each), soonest follow-up first.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "InteractionHandoversController.mine" } }, "/interaction-handovers/{id}/clear-review": { "post": { "x-controller-name": "InteractionHandoversController", "x-operation-name": "clearReview", "tags": [ "InteractionHandoversController" ], "responses": { "200": { "description": "Owner clears a returned-for-review handover: awaiting_review → completed (linked task completed, needs_follow_up cleared). No notification. 403 caller is not the owner; 409 wrong state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionHandovers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InteractionHandoversController.clearReview" } }, "/interaction-handovers/{id}/complete": { "post": { "x-controller-name": "InteractionHandoversController", "x-operation-name": "complete", "tags": [ "InteractionHandoversController" ], "responses": { "200": { "description": "Assignee marks the handed-over followup done. return_to_owner=1 → awaiting_review (owner alerted via followupHandedBack); 0 → completed outright (linked task completed, needs_follow_up cleared, nobody notified). 403 caller is not the assignee; 409 wrong state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionHandovers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InteractionHandoversController.complete" } }, "/interaction-handovers/{id}/recall": { "post": { "x-controller-name": "InteractionHandoversController", "x-operation-name": "recall", "tags": [ "InteractionHandoversController" ], "responses": { "200": { "description": "Owner recalls an assigned (not-yet-completed) handover: assigned → recalled. The linked task assignee reverts to the implicit owner. Silent (phase 1). 403 caller is not the owner; 409 wrong state (recall is only possible before the assignee completes).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionHandovers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InteractionHandoversController.recall" } }, "/interaction-types/count": { "get": { "x-controller-name": "InteractionTypesController", "x-operation-name": "count", "tags": [ "InteractionTypesController" ], "responses": { "200": { "description": "InteractionTypes model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "InteractionTypes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "InteractionTypesController.count" } }, "/interaction-types/{id}": { "put": { "x-controller-name": "InteractionTypesController", "x-operation-name": "replaceById", "tags": [ "InteractionTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "InteractionTypes PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionTypes" } } }, "x-parameter-index": 1 }, "operationId": "InteractionTypesController.replaceById" }, "patch": { "x-controller-name": "InteractionTypesController", "x-operation-name": "updateById", "tags": [ "InteractionTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "InteractionTypes PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionTypesPartial" } } }, "x-parameter-index": 1 }, "operationId": "InteractionTypesController.updateById" }, "get": { "x-controller-name": "InteractionTypesController", "x-operation-name": "findById", "tags": [ "InteractionTypesController" ], "responses": { "200": { "description": "InteractionTypes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionTypesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionTypes.Filter" } } } } ], "operationId": "InteractionTypesController.findById" }, "delete": { "x-controller-name": "InteractionTypesController", "x-operation-name": "deleteById", "tags": [ "InteractionTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "InteractionTypes DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InteractionTypesController.deleteById" } }, "/interaction-types": { "post": { "x-controller-name": "InteractionTypesController", "x-operation-name": "create", "tags": [ "InteractionTypesController" ], "responses": { "200": { "description": "InteractionTypes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionTypes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewInteractionTypes" } } } }, "operationId": "InteractionTypesController.create" }, "patch": { "x-controller-name": "InteractionTypesController", "x-operation-name": "updateAll", "tags": [ "InteractionTypesController" ], "responses": { "200": { "description": "InteractionTypes PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "InteractionTypes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionTypesPartial" } } } }, "operationId": "InteractionTypesController.updateAll" }, "get": { "x-controller-name": "InteractionTypesController", "x-operation-name": "find", "tags": [ "InteractionTypesController" ], "responses": { "200": { "description": "Array of InteractionTypes model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InteractionTypesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionTypes.Filter1" } } } } ], "operationId": "InteractionTypesController.find" } }, "/interactions/count": { "get": { "x-controller-name": "InteractionsController", "x-operation-name": "count", "tags": [ "InteractionsController" ], "responses": { "200": { "description": "Interactions model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Interactions.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "InteractionsController.count" } }, "/interactions/{id}/handover": { "post": { "x-controller-name": "InteractionHandoversController", "x-operation-name": "handOver", "tags": [ "InteractionHandoversController" ], "responses": { "200": { "description": "Hand a flagged followup to another staff member. Owner-only (per the isMyFollowUp derivation); assignee must hold an internal-staff-section role. 404 unknown/deleted interaction; 422 not flagged / bad assignee / over-length note; 409 an active handover already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionHandovers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewInteractionHandover" } } }, "x-parameter-index": 1 }, "operationId": "InteractionHandoversController.handOver" } }, "/interactions/{id}/handovers": { "get": { "x-controller-name": "InteractionHandoversController", "x-operation-name": "historyForInteraction", "tags": [ "InteractionHandoversController" ], "responses": { "200": { "description": "One note's full handover history, newest first (the Notes-tab provenance strip). Includes terminal rows — they are the audit trail. 404 unknown interaction.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InteractionHandoversController.historyForInteraction" } }, "/interactions/{id}": { "put": { "x-controller-name": "InteractionsController", "x-operation-name": "replaceById", "tags": [ "InteractionsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Interactions PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Interactions" } } }, "x-parameter-index": 1 }, "operationId": "InteractionsController.replaceById" }, "patch": { "x-controller-name": "InteractionsController", "x-operation-name": "updateById", "tags": [ "InteractionsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Interactions PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsPatchById" } } }, "x-parameter-index": 1 }, "operationId": "InteractionsController.updateById" }, "get": { "x-controller-name": "InteractionsController", "x-operation-name": "findById", "tags": [ "InteractionsController" ], "responses": { "200": { "description": "Interactions model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Interactions.Filter" } } } } ], "operationId": "InteractionsController.findById" }, "delete": { "x-controller-name": "InteractionsController", "x-operation-name": "deleteById", "tags": [ "InteractionsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Interactions DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InteractionsController.deleteById" } }, "/interactions": { "post": { "x-controller-name": "InteractionsController", "x-operation-name": "create", "tags": [ "InteractionsController" ], "responses": { "200": { "description": "Interactions model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Interactions" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewInteractions" } } } }, "operationId": "InteractionsController.create" }, "patch": { "x-controller-name": "InteractionsController", "x-operation-name": "updateAll", "tags": [ "InteractionsController" ], "responses": { "200": { "description": "Interactions PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Interactions.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsPartial" } } } }, "operationId": "InteractionsController.updateAll" }, "get": { "x-controller-name": "InteractionsController", "x-operation-name": "find", "tags": [ "InteractionsController" ], "responses": { "200": { "description": "Array of Interactions model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InteractionsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Interactions.Filter1" } } } } ], "operationId": "InteractionsController.find" } }, "/logs/count": { "get": { "x-controller-name": "LogsController", "x-operation-name": "count", "tags": [ "LogsController" ], "responses": { "200": { "description": "Log model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Log.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LogsController.count" } }, "/logs/entities": { "get": { "x-controller-name": "LogsController", "x-operation-name": "entities", "tags": [ "LogsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Distinct log entities with row counts" } } } } }, "operationId": "LogsController.entities" } }, "/logs/ip-geo": { "get": { "x-controller-name": "LogsController", "x-operation-name": "ipGeo", "tags": [ "LogsController" ], "responses": { "200": { "description": "Best-effort geolocation label for an IP", "content": { "application/json": { "schema": { "type": "object", "properties": { "location": { "type": "string", "nullable": true } } } } } } }, "parameters": [ { "name": "ip", "in": "query", "schema": { "type": "string" } } ], "operationId": "LogsController.ipGeo" } }, "/logs/search": { "get": { "x-controller-name": "LogsController", "x-operation-name": "search", "tags": [ "LogsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Filtered, paginated access-log search with total + daily avg-executionTime series" } } } } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "entity", "in": "query", "schema": { "type": "string" } }, { "name": "tab", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "orderDir", "in": "query", "schema": { "type": "string" } } ], "operationId": "LogsController.search" } }, "/logs/{id}": { "put": { "x-controller-name": "LogsController", "x-operation-name": "replaceById", "tags": [ "LogsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Log PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Log" } } }, "x-parameter-index": 1 }, "operationId": "LogsController.replaceById" }, "patch": { "x-controller-name": "LogsController", "x-operation-name": "updateById", "tags": [ "LogsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Log PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogPartial" } } }, "x-parameter-index": 1 }, "operationId": "LogsController.updateById" }, "get": { "x-controller-name": "LogsController", "x-operation-name": "findById", "tags": [ "LogsController" ], "responses": { "200": { "description": "Log model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Log.Filter" } } } } ], "operationId": "LogsController.findById" }, "delete": { "x-controller-name": "LogsController", "x-operation-name": "deleteById", "tags": [ "LogsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Log DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LogsController.deleteById" } }, "/logs": { "post": { "x-controller-name": "LogsController", "x-operation-name": "create", "tags": [ "LogsController" ], "responses": { "200": { "description": "Log model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Log" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLog" } } } }, "operationId": "LogsController.create" }, "patch": { "x-controller-name": "LogsController", "x-operation-name": "updateAll", "tags": [ "LogsController" ], "responses": { "200": { "description": "Log PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Log.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogPartial" } } } }, "operationId": "LogsController.updateAll" }, "get": { "x-controller-name": "LogsController", "x-operation-name": "find", "tags": [ "LogsController" ], "responses": { "200": { "description": "Array of Log model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Log.Filter1" } } } } ], "operationId": "LogsController.find" } }, "/magic-link/{id}": { "get": { "x-controller-name": "MagicLinkController", "x-operation-name": "findById", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "MagicLink model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLinkWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLink.Filter" } } } } ], "operationId": "MagicLinkController.findById" } }, "/magic-links/request-sign-in-link": { "post": { "x-controller-name": "MagicLinkController", "x-operation-name": "requestSignInLink", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "Generic acknowledgement — always {sent:true}, regardless of whether the email matched an account (no enumeration signal).", "content": { "application/json": { "schema": { "type": "object", "properties": { "sent": { "type": "boolean" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" } } } } }, "required": true }, "operationId": "MagicLinkController.requestSignInLink" } }, "/magic-links/{id}/clear-erc-user": { "get": { "x-controller-name": "MagicLinkClearErcUserController", "x-operation-name": "getClearErcUser", "tags": [ "MagicLinkClearErcUserController" ], "responses": { "200": { "description": "ClearErcUser belonging to MagicLink", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUser" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MagicLinkClearErcUserController.getClearErcUser" } }, "/magic-links/{code}/request-new-invite": { "post": { "x-controller-name": "MagicLinkController", "x-operation-name": "requestNewInvite", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "Generic acknowledgement — always {sent:true}, regardless of whether the code existed or was reissuable (no enumeration signal).", "content": { "application/json": { "schema": { "type": "object", "properties": { "sent": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MagicLinkController.requestNewInvite" } }, "/magic-links/{id}/resend/{url}": { "post": { "x-controller-name": "MagicLinkController", "x-operation-name": "resendMagicLink", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "MagicLink model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLinkWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "url", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MagicLinkController.resendMagicLink" } }, "/magic-links/{code}/signed-pdf": { "get": { "x-controller-name": "MagicLinkController", "x-operation-name": "downloadSignedPdf", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MagicLinkController.downloadSignedPdf" } }, "/magic-links/{code}/verify-dob": { "post": { "x-controller-name": "MagicLinkController", "x-operation-name": "verifyDob", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "DOB verification result for an employee first-login invite", "content": { "application/json": { "schema": { "type": "object", "properties": { "verified": { "type": "boolean" }, "invalidated": { "type": "boolean" }, "attemptsRemaining": { "type": "number" } } } } } } }, "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "dob" ], "properties": { "dob": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "MagicLinkController.verifyDob" } }, "/magic-links/{code}/{url}": { "post": { "x-controller-name": "MagicLinkController", "x-operation-name": "actionMagicLink", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "MagicLink model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLink" } } } } }, "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "url", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "x-parameter-index": 2 }, "operationId": "MagicLinkController.actionMagicLink" }, "get": { "x-controller-name": "MagicLinkController", "x-operation-name": "findByCodeAndURL", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "MagicLink model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLinkWithRelations" } } } } }, "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MagicLinkController.findByCodeAndURL" } }, "/magic-links/{id}": { "patch": { "x-controller-name": "MagicLinkController", "x-operation-name": "updateById", "tags": [ "MagicLinkController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MagicLink PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLinkPartial" } } }, "x-parameter-index": 1 }, "operationId": "MagicLinkController.updateById" } }, "/magic-links/{code}": { "get": { "x-controller-name": "MagicLinkController", "x-operation-name": "findByCode", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "MagicLink model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLinkWithRelations" } } } } }, "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MagicLinkController.findByCode" } }, "/magic-links": { "post": { "x-controller-name": "MagicLinkController", "x-operation-name": "create", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "MagicLink model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLink" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMagicLink" } } } }, "operationId": "MagicLinkController.create" }, "get": { "x-controller-name": "MagicLinkController", "x-operation-name": "getAllMagicLinks", "tags": [ "MagicLinkController" ], "responses": { "200": { "description": "Magic link GET success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLinkWithRelations" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLink.Filter1" } } } } ], "operationId": "MagicLinkController.getAllMagicLinks" } }, "/mandate-binds/count": { "get": { "x-controller-name": "MandateBindsController", "x-operation-name": "count", "tags": [ "MandateBindsController" ], "responses": { "200": { "description": "MandateBinds model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateBinds.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateBindsController.count" } }, "/mandate-binds/{id}": { "put": { "x-controller-name": "MandateBindsController", "x-operation-name": "replaceById", "tags": [ "MandateBindsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateBinds PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateBinds" } } }, "x-parameter-index": 1 }, "operationId": "MandateBindsController.replaceById" }, "patch": { "x-controller-name": "MandateBindsController", "x-operation-name": "updateById", "tags": [ "MandateBindsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateBinds PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateBindsPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateBindsController.updateById" }, "get": { "x-controller-name": "MandateBindsController", "x-operation-name": "findById", "tags": [ "MandateBindsController" ], "responses": { "200": { "description": "MandateBinds model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateBindsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateBinds.Filter" } } } } ], "operationId": "MandateBindsController.findById" }, "delete": { "x-controller-name": "MandateBindsController", "x-operation-name": "deleteById", "tags": [ "MandateBindsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateBinds DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateBindsController.deleteById" } }, "/mandate-binds": { "post": { "x-controller-name": "MandateBindsController", "x-operation-name": "create", "tags": [ "MandateBindsController" ], "responses": { "200": { "description": "MandateBinds model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateBinds" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateBinds" } } } }, "operationId": "MandateBindsController.create" }, "patch": { "x-controller-name": "MandateBindsController", "x-operation-name": "updateAll", "tags": [ "MandateBindsController" ], "responses": { "200": { "description": "MandateBinds PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateBinds.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateBindsPartial" } } } }, "operationId": "MandateBindsController.updateAll" }, "get": { "x-controller-name": "MandateBindsController", "x-operation-name": "find", "tags": [ "MandateBindsController" ], "responses": { "200": { "description": "Array of MandateBinds model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateBindsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateBinds.Filter1" } } } } ], "operationId": "MandateBindsController.find" } }, "/mandate-effect-group-entries/count": { "get": { "x-controller-name": "MandateEffectGroupEntriesController", "x-operation-name": "count", "tags": [ "MandateEffectGroupEntriesController" ], "responses": { "200": { "description": "MandateEffectGroupEntries model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateEffectGroupEntries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateEffectGroupEntriesController.count" } }, "/mandate-effect-group-entries/{id}": { "put": { "x-controller-name": "MandateEffectGroupEntriesController", "x-operation-name": "replaceById", "tags": [ "MandateEffectGroupEntriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectGroupEntries PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroupEntries" } } }, "x-parameter-index": 1 }, "operationId": "MandateEffectGroupEntriesController.replaceById" }, "patch": { "x-controller-name": "MandateEffectGroupEntriesController", "x-operation-name": "updateById", "tags": [ "MandateEffectGroupEntriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectGroupEntries PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroupEntriesPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateEffectGroupEntriesController.updateById" }, "get": { "x-controller-name": "MandateEffectGroupEntriesController", "x-operation-name": "findById", "tags": [ "MandateEffectGroupEntriesController" ], "responses": { "200": { "description": "MandateEffectGroupEntries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroupEntriesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroupEntries.Filter" } } } } ], "operationId": "MandateEffectGroupEntriesController.findById" }, "delete": { "x-controller-name": "MandateEffectGroupEntriesController", "x-operation-name": "deleteById", "tags": [ "MandateEffectGroupEntriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectGroupEntries DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateEffectGroupEntriesController.deleteById" } }, "/mandate-effect-group-entries": { "post": { "x-controller-name": "MandateEffectGroupEntriesController", "x-operation-name": "create", "tags": [ "MandateEffectGroupEntriesController" ], "responses": { "200": { "description": "MandateEffectGroupEntries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroupEntries" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateEffectGroupEntries" } } } }, "operationId": "MandateEffectGroupEntriesController.create" }, "patch": { "x-controller-name": "MandateEffectGroupEntriesController", "x-operation-name": "updateAll", "tags": [ "MandateEffectGroupEntriesController" ], "responses": { "200": { "description": "MandateEffectGroupEntries PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateEffectGroupEntries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroupEntriesPartial" } } } }, "operationId": "MandateEffectGroupEntriesController.updateAll" }, "get": { "x-controller-name": "MandateEffectGroupEntriesController", "x-operation-name": "find", "tags": [ "MandateEffectGroupEntriesController" ], "responses": { "200": { "description": "Array of MandateEffectGroupEntries model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateEffectGroupEntriesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroupEntries.Filter1" } } } } ], "operationId": "MandateEffectGroupEntriesController.find" } }, "/mandate-effect-groups/count": { "get": { "x-controller-name": "MandateEffectGroupsController", "x-operation-name": "count", "tags": [ "MandateEffectGroupsController" ], "responses": { "200": { "description": "MandateEffectGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateEffectGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateEffectGroupsController.count" } }, "/mandate-effect-groups/{id}": { "put": { "x-controller-name": "MandateEffectGroupsController", "x-operation-name": "replaceById", "tags": [ "MandateEffectGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroups" } } }, "x-parameter-index": 1 }, "operationId": "MandateEffectGroupsController.replaceById" }, "patch": { "x-controller-name": "MandateEffectGroupsController", "x-operation-name": "updateById", "tags": [ "MandateEffectGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateEffectGroupsController.updateById" }, "get": { "x-controller-name": "MandateEffectGroupsController", "x-operation-name": "findById", "tags": [ "MandateEffectGroupsController" ], "responses": { "200": { "description": "MandateEffectGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroups.Filter" } } } } ], "operationId": "MandateEffectGroupsController.findById" }, "delete": { "x-controller-name": "MandateEffectGroupsController", "x-operation-name": "deleteById", "tags": [ "MandateEffectGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateEffectGroupsController.deleteById" } }, "/mandate-effect-groups": { "post": { "x-controller-name": "MandateEffectGroupsController", "x-operation-name": "create", "tags": [ "MandateEffectGroupsController" ], "responses": { "200": { "description": "MandateEffectGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateEffectGroups" } } } }, "operationId": "MandateEffectGroupsController.create" }, "patch": { "x-controller-name": "MandateEffectGroupsController", "x-operation-name": "updateAll", "tags": [ "MandateEffectGroupsController" ], "responses": { "200": { "description": "MandateEffectGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateEffectGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroupsPartial" } } } }, "operationId": "MandateEffectGroupsController.updateAll" }, "get": { "x-controller-name": "MandateEffectGroupsController", "x-operation-name": "find", "tags": [ "MandateEffectGroupsController" ], "responses": { "200": { "description": "Array of MandateEffectGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateEffectGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectGroups.Filter1" } } } } ], "operationId": "MandateEffectGroupsController.find" } }, "/mandate-effect-industries/count": { "get": { "x-controller-name": "MandateEffectIndustryController", "x-operation-name": "count", "tags": [ "MandateEffectIndustryController" ], "responses": { "200": { "description": "MandateEffectIndustry model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateEffectIndustry.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateEffectIndustryController.count" } }, "/mandate-effect-industries/{id}": { "put": { "x-controller-name": "MandateEffectIndustryController", "x-operation-name": "replaceById", "tags": [ "MandateEffectIndustryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectIndustry PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustry" } } }, "x-parameter-index": 1 }, "operationId": "MandateEffectIndustryController.replaceById" }, "patch": { "x-controller-name": "MandateEffectIndustryController", "x-operation-name": "updateById", "tags": [ "MandateEffectIndustryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectIndustry PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustryPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateEffectIndustryController.updateById" }, "get": { "x-controller-name": "MandateEffectIndustryController", "x-operation-name": "findById", "tags": [ "MandateEffectIndustryController" ], "responses": { "200": { "description": "MandateEffectIndustry model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustryWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustry.Filter" } } } } ], "operationId": "MandateEffectIndustryController.findById" }, "delete": { "x-controller-name": "MandateEffectIndustryController", "x-operation-name": "deleteById", "tags": [ "MandateEffectIndustryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectIndustry DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateEffectIndustryController.deleteById" } }, "/mandate-effect-industries": { "post": { "x-controller-name": "MandateEffectIndustryController", "x-operation-name": "create", "tags": [ "MandateEffectIndustryController" ], "responses": { "200": { "description": "MandateEffectIndustry model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustry" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateEffectIndustry" } } } }, "operationId": "MandateEffectIndustryController.create" }, "patch": { "x-controller-name": "MandateEffectIndustryController", "x-operation-name": "updateAll", "tags": [ "MandateEffectIndustryController" ], "responses": { "200": { "description": "MandateEffectIndustry PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateEffectIndustry.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustryPartial" } } } }, "operationId": "MandateEffectIndustryController.updateAll" }, "get": { "x-controller-name": "MandateEffectIndustryController", "x-operation-name": "find", "tags": [ "MandateEffectIndustryController" ], "responses": { "200": { "description": "Array of MandateEffectIndustry model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateEffectIndustryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustry.Filter1" } } } } ], "operationId": "MandateEffectIndustryController.find" } }, "/mandate-effect-industry-groups/count": { "get": { "x-controller-name": "MandateEffectIndustryGroupController", "x-operation-name": "count", "tags": [ "MandateEffectIndustryGroupController" ], "responses": { "200": { "description": "MandateEffectIndustryGroup model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateEffectIndustryGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateEffectIndustryGroupController.count" } }, "/mandate-effect-industry-groups/{id}": { "put": { "x-controller-name": "MandateEffectIndustryGroupController", "x-operation-name": "replaceById", "tags": [ "MandateEffectIndustryGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectIndustryGroup PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustryGroup" } } }, "x-parameter-index": 1 }, "operationId": "MandateEffectIndustryGroupController.replaceById" }, "patch": { "x-controller-name": "MandateEffectIndustryGroupController", "x-operation-name": "updateById", "tags": [ "MandateEffectIndustryGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectIndustryGroup PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustryGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateEffectIndustryGroupController.updateById" }, "get": { "x-controller-name": "MandateEffectIndustryGroupController", "x-operation-name": "findById", "tags": [ "MandateEffectIndustryGroupController" ], "responses": { "200": { "description": "MandateEffectIndustryGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustryGroupWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustryGroup.Filter" } } } } ], "operationId": "MandateEffectIndustryGroupController.findById" }, "delete": { "x-controller-name": "MandateEffectIndustryGroupController", "x-operation-name": "deleteById", "tags": [ "MandateEffectIndustryGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffectIndustryGroup DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateEffectIndustryGroupController.deleteById" } }, "/mandate-effect-industry-groups": { "post": { "x-controller-name": "MandateEffectIndustryGroupController", "x-operation-name": "create", "tags": [ "MandateEffectIndustryGroupController" ], "responses": { "200": { "description": "MandateEffectIndustryGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustryGroup" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateEffectIndustryGroup" } } } }, "operationId": "MandateEffectIndustryGroupController.create" }, "patch": { "x-controller-name": "MandateEffectIndustryGroupController", "x-operation-name": "updateAll", "tags": [ "MandateEffectIndustryGroupController" ], "responses": { "200": { "description": "MandateEffectIndustryGroup PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateEffectIndustryGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustryGroupPartial" } } } }, "operationId": "MandateEffectIndustryGroupController.updateAll" }, "get": { "x-controller-name": "MandateEffectIndustryGroupController", "x-operation-name": "find", "tags": [ "MandateEffectIndustryGroupController" ], "responses": { "200": { "description": "Array of MandateEffectIndustryGroup model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateEffectIndustryGroupWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectIndustryGroup.Filter1" } } } } ], "operationId": "MandateEffectIndustryGroupController.find" } }, "/mandate-effects/count": { "get": { "x-controller-name": "MandateEffectController", "x-operation-name": "count", "tags": [ "MandateEffectController" ], "responses": { "200": { "description": "MandateEffects model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateEffects.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateEffectController.count" } }, "/mandate-effects/{id}": { "put": { "x-controller-name": "MandateEffectController", "x-operation-name": "replaceById", "tags": [ "MandateEffectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffects PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffects" } } }, "x-parameter-index": 1 }, "operationId": "MandateEffectController.replaceById" }, "patch": { "x-controller-name": "MandateEffectController", "x-operation-name": "updateById", "tags": [ "MandateEffectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffects PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectsPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateEffectController.updateById" }, "get": { "x-controller-name": "MandateEffectController", "x-operation-name": "findById", "tags": [ "MandateEffectController" ], "responses": { "200": { "description": "MandateEffects model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffects.Filter" } } } } ], "operationId": "MandateEffectController.findById" }, "delete": { "x-controller-name": "MandateEffectController", "x-operation-name": "deleteById", "tags": [ "MandateEffectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateEffects DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateEffectController.deleteById" } }, "/mandate-effects": { "post": { "x-controller-name": "MandateEffectController", "x-operation-name": "create", "tags": [ "MandateEffectController" ], "responses": { "200": { "description": "MandateEffects model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffects" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateEffects" } } } }, "operationId": "MandateEffectController.create" }, "patch": { "x-controller-name": "MandateEffectController", "x-operation-name": "updateAll", "tags": [ "MandateEffectController" ], "responses": { "200": { "description": "MandateEffects PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateEffects.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffectsPartial" } } } }, "operationId": "MandateEffectController.updateAll" }, "get": { "x-controller-name": "MandateEffectController", "x-operation-name": "find", "tags": [ "MandateEffectController" ], "responses": { "200": { "description": "Array of MandateEffects model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateEffectsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateEffects.Filter1" } } } } ], "operationId": "MandateEffectController.find" } }, "/mandate-industries/count": { "get": { "x-controller-name": "MandateIndustriesController", "x-operation-name": "count", "tags": [ "MandateIndustriesController" ], "responses": { "200": { "description": "MandateIndustries model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateIndustries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateIndustriesController.count" } }, "/mandate-industries/{id}": { "put": { "x-controller-name": "MandateIndustriesController", "x-operation-name": "replaceById", "tags": [ "MandateIndustriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateIndustries PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustries" } } }, "x-parameter-index": 1 }, "operationId": "MandateIndustriesController.replaceById" }, "patch": { "x-controller-name": "MandateIndustriesController", "x-operation-name": "updateById", "tags": [ "MandateIndustriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateIndustries PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustriesPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateIndustriesController.updateById" }, "get": { "x-controller-name": "MandateIndustriesController", "x-operation-name": "findById", "tags": [ "MandateIndustriesController" ], "responses": { "200": { "description": "MandateIndustries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustriesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustries.Filter" } } } } ], "operationId": "MandateIndustriesController.findById" }, "delete": { "x-controller-name": "MandateIndustriesController", "x-operation-name": "deleteById", "tags": [ "MandateIndustriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateIndustries DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateIndustriesController.deleteById" } }, "/mandate-industries": { "post": { "x-controller-name": "MandateIndustriesController", "x-operation-name": "create", "tags": [ "MandateIndustriesController" ], "responses": { "200": { "description": "MandateIndustries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustries" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateIndustries" } } } }, "operationId": "MandateIndustriesController.create" }, "patch": { "x-controller-name": "MandateIndustriesController", "x-operation-name": "updateAll", "tags": [ "MandateIndustriesController" ], "responses": { "200": { "description": "MandateIndustries PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateIndustries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustriesPartial" } } } }, "operationId": "MandateIndustriesController.updateAll" }, "get": { "x-controller-name": "MandateIndustriesController", "x-operation-name": "find", "tags": [ "MandateIndustriesController" ], "responses": { "200": { "description": "Array of MandateIndustries model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateIndustriesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustries.Filter1" } } } } ], "operationId": "MandateIndustriesController.find" } }, "/mandate-industry-groups/count": { "get": { "x-controller-name": "MandateIndustryGroupsController", "x-operation-name": "count", "tags": [ "MandateIndustryGroupsController" ], "responses": { "200": { "description": "MandateIndustryGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateIndustryGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateIndustryGroupsController.count" } }, "/mandate-industry-groups/{id}": { "put": { "x-controller-name": "MandateIndustryGroupsController", "x-operation-name": "replaceById", "tags": [ "MandateIndustryGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateIndustryGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustryGroups" } } }, "x-parameter-index": 1 }, "operationId": "MandateIndustryGroupsController.replaceById" }, "patch": { "x-controller-name": "MandateIndustryGroupsController", "x-operation-name": "updateById", "tags": [ "MandateIndustryGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateIndustryGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustryGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateIndustryGroupsController.updateById" }, "get": { "x-controller-name": "MandateIndustryGroupsController", "x-operation-name": "findById", "tags": [ "MandateIndustryGroupsController" ], "responses": { "200": { "description": "MandateIndustryGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustryGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustryGroups.Filter" } } } } ], "operationId": "MandateIndustryGroupsController.findById" }, "delete": { "x-controller-name": "MandateIndustryGroupsController", "x-operation-name": "deleteById", "tags": [ "MandateIndustryGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateIndustryGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateIndustryGroupsController.deleteById" } }, "/mandate-industry-groups": { "post": { "x-controller-name": "MandateIndustryGroupsController", "x-operation-name": "create", "tags": [ "MandateIndustryGroupsController" ], "responses": { "200": { "description": "MandateIndustryGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustryGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateIndustryGroups" } } } }, "operationId": "MandateIndustryGroupsController.create" }, "patch": { "x-controller-name": "MandateIndustryGroupsController", "x-operation-name": "updateAll", "tags": [ "MandateIndustryGroupsController" ], "responses": { "200": { "description": "MandateIndustryGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateIndustryGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustryGroupsPartial" } } } }, "operationId": "MandateIndustryGroupsController.updateAll" }, "get": { "x-controller-name": "MandateIndustryGroupsController", "x-operation-name": "find", "tags": [ "MandateIndustryGroupsController" ], "responses": { "200": { "description": "Array of MandateIndustryGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateIndustryGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateIndustryGroups.Filter1" } } } } ], "operationId": "MandateIndustryGroupsController.find" } }, "/mandate-mandate-effects/count": { "get": { "x-controller-name": "MandateMandateEffectController", "x-operation-name": "count", "tags": [ "MandateMandateEffectController" ], "responses": { "200": { "description": "MandateMandateEffects model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateMandateEffect.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateMandateEffectController.count" } }, "/mandate-mandate-effects/{id}": { "patch": { "x-controller-name": "MandateMandateEffectController", "x-operation-name": "updateById", "tags": [ "MandateMandateEffectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Mandates mandate effects PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateMandateEffectPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateMandateEffectController.updateById" }, "get": { "x-controller-name": "MandateMandateEffectController", "x-operation-name": "findById", "tags": [ "MandateMandateEffectController" ], "responses": { "200": { "description": "MandateMandateEffects model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateMandateEffectWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateMandateEffect.Filter" } } } } ], "operationId": "MandateMandateEffectController.findById" }, "delete": { "x-controller-name": "MandateMandateEffectController", "x-operation-name": "deleteById", "tags": [ "MandateMandateEffectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateMandateEffect DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateMandateEffectController.deleteById" } }, "/mandate-mandate-effects": { "post": { "x-controller-name": "MandateMandateEffectController", "x-operation-name": "create", "tags": [ "MandateMandateEffectController" ], "responses": { "200": { "description": "MandateMandateEffects model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateMandateEffect" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateMandateEffects" } } } }, "operationId": "MandateMandateEffectController.create" }, "get": { "x-controller-name": "MandateMandateEffectController", "x-operation-name": "find", "tags": [ "MandateMandateEffectController" ], "responses": { "200": { "description": "Array of MandateMandateEffects model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateMandateEffectWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateMandateEffect.Filter1" } } } } ], "operationId": "MandateMandateEffectController.find" } }, "/mandate-paragraph-industries/count": { "get": { "x-controller-name": "MandateParagraphIndustryController", "x-operation-name": "count", "tags": [ "MandateParagraphIndustryController" ], "responses": { "200": { "description": "MandateParagraphIndustries model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateParagraphIndustries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateParagraphIndustryController.count" } }, "/mandate-paragraph-industries/{id}": { "put": { "x-controller-name": "MandateParagraphIndustryController", "x-operation-name": "replaceById", "tags": [ "MandateParagraphIndustryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateParagraphIndustries PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustries" } } }, "x-parameter-index": 1 }, "operationId": "MandateParagraphIndustryController.replaceById" }, "patch": { "x-controller-name": "MandateParagraphIndustryController", "x-operation-name": "updateById", "tags": [ "MandateParagraphIndustryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateParagraphIndustries PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustriesPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateParagraphIndustryController.updateById" }, "get": { "x-controller-name": "MandateParagraphIndustryController", "x-operation-name": "findById", "tags": [ "MandateParagraphIndustryController" ], "responses": { "200": { "description": "MandateParagraphIndustries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustriesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustries.Filter" } } } } ], "operationId": "MandateParagraphIndustryController.findById" }, "delete": { "x-controller-name": "MandateParagraphIndustryController", "x-operation-name": "deleteById", "tags": [ "MandateParagraphIndustryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateParagraphIndustries DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateParagraphIndustryController.deleteById" } }, "/mandate-paragraph-industries": { "post": { "x-controller-name": "MandateParagraphIndustryController", "x-operation-name": "create", "tags": [ "MandateParagraphIndustryController" ], "responses": { "200": { "description": "MandateParagraphIndustries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustries" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateParagraphIndustries" } } } }, "operationId": "MandateParagraphIndustryController.create" }, "patch": { "x-controller-name": "MandateParagraphIndustryController", "x-operation-name": "updateAll", "tags": [ "MandateParagraphIndustryController" ], "responses": { "200": { "description": "MandateParagraphIndustries PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateParagraphIndustries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustriesPartial" } } } }, "operationId": "MandateParagraphIndustryController.updateAll" }, "get": { "x-controller-name": "MandateParagraphIndustryController", "x-operation-name": "find", "tags": [ "MandateParagraphIndustryController" ], "responses": { "200": { "description": "Array of MandateParagraphIndustries model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateParagraphIndustriesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustries.Filter1" } } } } ], "operationId": "MandateParagraphIndustryController.find" } }, "/mandate-paragraph-industry-groups/count": { "get": { "x-controller-name": "MandateParagraphIndustryGroupController", "x-operation-name": "count", "tags": [ "MandateParagraphIndustryGroupController" ], "responses": { "200": { "description": "MandateParagraphIndustryGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateParagraphIndustryGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateParagraphIndustryGroupController.count" } }, "/mandate-paragraph-industry-groups/{id}": { "put": { "x-controller-name": "MandateParagraphIndustryGroupController", "x-operation-name": "replaceById", "tags": [ "MandateParagraphIndustryGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateParagraphIndustryGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustryGroups" } } }, "x-parameter-index": 1 }, "operationId": "MandateParagraphIndustryGroupController.replaceById" }, "patch": { "x-controller-name": "MandateParagraphIndustryGroupController", "x-operation-name": "updateById", "tags": [ "MandateParagraphIndustryGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateParagraphIndustryGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustryGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateParagraphIndustryGroupController.updateById" }, "get": { "x-controller-name": "MandateParagraphIndustryGroupController", "x-operation-name": "findById", "tags": [ "MandateParagraphIndustryGroupController" ], "responses": { "200": { "description": "MandateParagraphIndustryGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustryGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustryGroups.Filter" } } } } ], "operationId": "MandateParagraphIndustryGroupController.findById" }, "delete": { "x-controller-name": "MandateParagraphIndustryGroupController", "x-operation-name": "deleteById", "tags": [ "MandateParagraphIndustryGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateParagraphIndustryGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateParagraphIndustryGroupController.deleteById" } }, "/mandate-paragraph-industry-groups": { "post": { "x-controller-name": "MandateParagraphIndustryGroupController", "x-operation-name": "create", "tags": [ "MandateParagraphIndustryGroupController" ], "responses": { "200": { "description": "MandateParagraphIndustryGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustryGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateParagraphIndustryGroups" } } } }, "operationId": "MandateParagraphIndustryGroupController.create" }, "patch": { "x-controller-name": "MandateParagraphIndustryGroupController", "x-operation-name": "updateAll", "tags": [ "MandateParagraphIndustryGroupController" ], "responses": { "200": { "description": "MandateParagraphIndustryGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateParagraphIndustryGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustryGroupsPartial" } } } }, "operationId": "MandateParagraphIndustryGroupController.updateAll" }, "get": { "x-controller-name": "MandateParagraphIndustryGroupController", "x-operation-name": "find", "tags": [ "MandateParagraphIndustryGroupController" ], "responses": { "200": { "description": "Array of MandateParagraphIndustryGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateParagraphIndustryGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateParagraphIndustryGroups.Filter1" } } } } ], "operationId": "MandateParagraphIndustryGroupController.find" } }, "/mandate-types/count": { "get": { "x-controller-name": "MandateTypesController", "x-operation-name": "count", "tags": [ "MandateTypesController" ], "responses": { "200": { "description": "MandateTypes model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateTypes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandateTypesController.count" } }, "/mandate-types/{id}": { "put": { "x-controller-name": "MandateTypesController", "x-operation-name": "replaceById", "tags": [ "MandateTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateTypes PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateTypes" } } }, "x-parameter-index": 1 }, "operationId": "MandateTypesController.replaceById" }, "patch": { "x-controller-name": "MandateTypesController", "x-operation-name": "updateById", "tags": [ "MandateTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateTypes PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateTypesPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandateTypesController.updateById" }, "get": { "x-controller-name": "MandateTypesController", "x-operation-name": "findById", "tags": [ "MandateTypesController" ], "responses": { "200": { "description": "MandateTypes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateTypesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateTypes.Filter" } } } } ], "operationId": "MandateTypesController.findById" }, "delete": { "x-controller-name": "MandateTypesController", "x-operation-name": "deleteById", "tags": [ "MandateTypesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MandateTypes DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandateTypesController.deleteById" } }, "/mandate-types": { "post": { "x-controller-name": "MandateTypesController", "x-operation-name": "create", "tags": [ "MandateTypesController" ], "responses": { "200": { "description": "MandateTypes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateTypes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandateTypes" } } } }, "operationId": "MandateTypesController.create" }, "patch": { "x-controller-name": "MandateTypesController", "x-operation-name": "updateAll", "tags": [ "MandateTypesController" ], "responses": { "200": { "description": "MandateTypes PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MandateTypes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateTypesPartial" } } } }, "operationId": "MandateTypesController.updateAll" }, "get": { "x-controller-name": "MandateTypesController", "x-operation-name": "find", "tags": [ "MandateTypesController" ], "responses": { "200": { "description": "Array of MandateTypes model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateTypesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateTypes.Filter1" } } } } ], "operationId": "MandateTypesController.find" } }, "/mandates/count": { "get": { "x-controller-name": "MandatesController", "x-operation-name": "count", "tags": [ "MandatesController" ], "responses": { "200": { "description": "Mandates model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Mandates.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MandatesController.count" } }, "/mandates/{id}": { "put": { "x-controller-name": "MandatesController", "x-operation-name": "replaceById", "tags": [ "MandatesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Mandates PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mandates" } } }, "x-parameter-index": 1 }, "operationId": "MandatesController.replaceById" }, "patch": { "x-controller-name": "MandatesController", "x-operation-name": "updateById", "tags": [ "MandatesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Mandates PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandatesPartial" } } }, "x-parameter-index": 1 }, "operationId": "MandatesController.updateById" }, "get": { "x-controller-name": "MandatesController", "x-operation-name": "findById", "tags": [ "MandatesController" ], "responses": { "200": { "description": "Mandates model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandatesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mandates.Filter" } } } } ], "operationId": "MandatesController.findById" }, "delete": { "x-controller-name": "MandatesController", "x-operation-name": "deleteById", "tags": [ "MandatesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Mandates DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MandatesController.deleteById" } }, "/mandates": { "post": { "x-controller-name": "MandatesController", "x-operation-name": "create", "tags": [ "MandatesController" ], "responses": { "200": { "description": "Mandates model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mandates" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMandates" } } } }, "operationId": "MandatesController.create" }, "patch": { "x-controller-name": "MandatesController", "x-operation-name": "updateAll", "tags": [ "MandatesController" ], "responses": { "200": { "description": "Mandates PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Mandates.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandatesPartial" } } } }, "operationId": "MandatesController.updateAll" }, "get": { "x-controller-name": "MandatesController", "x-operation-name": "find", "tags": [ "MandatesController" ], "responses": { "200": { "description": "Array of Mandates model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandatesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mandates.Filter1" } } } } ], "operationId": "MandatesController.find" } }, "/me/push-tokens/{deviceId}": { "delete": { "x-controller-name": "PushTokenController", "x-operation-name": "deleteMine", "tags": [ "PushTokenController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete the caller's push token for a device (logout)." } } } } }, "parameters": [ { "name": "deviceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PushTokenController.deleteMine" } }, "/me/push-tokens": { "post": { "x-controller-name": "PushTokenController", "x-operation-name": "registerMine", "tags": [ "PushTokenController" ], "responses": { "200": { "description": "Register (upsert) the caller's push token for a device.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "platform": { "type": "string", "nullable": true } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushTokenSave" } } } }, "operationId": "PushTokenController.registerMine" } }, "/mock-finch/admin/fleet": { "get": { "x-controller-name": "MockFinchAdminController", "x-operation-name": "fleet", "tags": [ "MockFinchAdminController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Fleet summaries" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } } ], "operationId": "MockFinchAdminController.fleet" } }, "/mock-finch/admin/overlay/deductions": { "post": { "x-controller-name": "MockFinchAdminController", "x-operation-name": "setDeductions", "tags": [ "MockFinchAdminController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Deduction override applied" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyToken", "individualId", "deductions" ], "properties": { "companyToken": { "type": "string" }, "individualId": { "type": "string" }, "deductions": { "type": "array", "items": { "type": "object", "required": [ "type", "amount" ], "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "amount": { "type": "number", "description": "CENTS" }, "preTax": { "type": "boolean" } } } } } } } } }, "operationId": "MockFinchAdminController.setDeductions" } }, "/mock-finch/admin/overlay/reset": { "post": { "x-controller-name": "MockFinchAdminController", "x-operation-name": "resetOverlay", "tags": [ "MockFinchAdminController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Overlay reset" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false }, "operationId": "MockFinchAdminController.resetOverlay" } }, "/mock-finch/admin/webhooks/trigger": { "post": { "x-controller-name": "MockFinchAdminController", "x-operation-name": "trigger", "tags": [ "MockFinchAdminController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Trigger result" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "beat" ], "properties": { "beat": { "type": "string", "enum": [ "new_hire", "termination", "pay_statement", "data_sync" ] }, "companyToken": { "type": "string" }, "companyIndex": { "type": "number" }, "connectionId": { "type": "string" }, "individualId": { "type": "string" } } } } } }, "operationId": "MockFinchAdminController.trigger" } }, "/mock-finch/auth/token": { "post": { "x-controller-name": "MockFinchController", "x-operation-name": "authToken", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Access token" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false }, "operationId": "MockFinchController.authToken" } }, "/mock-finch/disconnect": { "post": { "x-controller-name": "MockFinchController", "x-operation-name": "disconnect", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Disconnect" } } } } }, "operationId": "MockFinchController.disconnect" } }, "/mock-finch/employer/benefits/{benefit_id}/individuals": { "post": { "x-controller-name": "MockFinchController", "x-operation-name": "enrollIndividuals", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Enroll individuals" } } } } }, "parameters": [ { "name": "benefit_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "MockFinchController.enrollIndividuals" }, "delete": { "x-controller-name": "MockFinchController", "x-operation-name": "unenrollIndividuals", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Unenroll individuals" } } } } }, "parameters": [ { "name": "benefit_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false, "x-parameter-index": 1 }, "operationId": "MockFinchController.unenrollIndividuals" } }, "/mock-finch/employer/benefits": { "post": { "x-controller-name": "MockFinchController", "x-operation-name": "createBenefit", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create company benefit" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false }, "operationId": "MockFinchController.createBenefit" }, "get": { "x-controller-name": "MockFinchController", "x-operation-name": "listBenefits", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "List company benefits" } } } } }, "operationId": "MockFinchController.listBenefits" } }, "/mock-finch/employer/company": { "get": { "x-controller-name": "MockFinchController", "x-operation-name": "company", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Company" } } } } }, "operationId": "MockFinchController.company" } }, "/mock-finch/employer/directory": { "get": { "x-controller-name": "MockFinchController", "x-operation-name": "directory", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Directory" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } } ], "operationId": "MockFinchController.directory" } }, "/mock-finch/employer/documents": { "get": { "x-controller-name": "MockFinchController", "x-operation-name": "documents", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Documents" } } } } }, "operationId": "MockFinchController.documents" } }, "/mock-finch/employer/employment": { "post": { "x-controller-name": "MockFinchController", "x-operation-name": "employment", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Employments" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false }, "operationId": "MockFinchController.employment" } }, "/mock-finch/employer/individual": { "post": { "x-controller-name": "MockFinchController", "x-operation-name": "individual", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Individuals" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false }, "operationId": "MockFinchController.individual" } }, "/mock-finch/employer/pay-statement": { "post": { "x-controller-name": "MockFinchController", "x-operation-name": "payStatement", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Pay statements" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false }, "operationId": "MockFinchController.payStatement" } }, "/mock-finch/employer/payment": { "get": { "x-controller-name": "MockFinchController", "x-operation-name": "payment", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Payments" } } } } }, "parameters": [ { "name": "start_date", "in": "query", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "schema": { "type": "string" } } ], "operationId": "MockFinchController.payment" } }, "/mock-finch/introspect": { "get": { "x-controller-name": "MockFinchController", "x-operation-name": "introspect", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Introspect" } } } } }, "operationId": "MockFinchController.introspect" } }, "/mock-finch/jobs/manual/{job_id}": { "get": { "x-controller-name": "MockFinchController", "x-operation-name": "manualJob", "tags": [ "MockFinchController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Manual job" } } } } }, "parameters": [ { "name": "job_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MockFinchController.manualJob" } }, "/monday-sync-data/count": { "get": { "x-controller-name": "MondaySyncDataController", "x-operation-name": "count", "tags": [ "MondaySyncDataController" ], "responses": { "200": { "description": "MondaySyncData model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MondaySyncData.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MondaySyncDataController.count" } }, "/monday-sync-data/{id}": { "get": { "x-controller-name": "MondaySyncDataController", "x-operation-name": "findById", "tags": [ "MondaySyncDataController" ], "responses": { "200": { "description": "MondaySyncData model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MondaySyncDataWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MondaySyncData.Filter" } } } } ], "operationId": "MondaySyncDataController.findById" } }, "/monday-sync-data": { "get": { "x-controller-name": "MondaySyncDataController", "x-operation-name": "find", "tags": [ "MondaySyncDataController" ], "responses": { "200": { "description": "Array of MondaySyncData model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MondaySyncDataWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MondaySyncData.Filter1" } } } } ], "operationId": "MondaySyncDataController.find" } }, "/multitenants/branding": { "get": { "x-controller-name": "MultitenantsController", "x-operation-name": "publicBranding", "tags": [ "MultitenantsController" ], "responses": { "200": { "description": "One tenant's public display branding, resolved by domain", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "logo": { "type": "string" }, "smallLogo": { "type": "string" }, "emailLogoUrl": { "type": "string" } } } } } } }, "parameters": [ { "name": "domain", "in": "query", "schema": { "type": "string" } } ], "operationId": "MultitenantsController.publicBranding" } }, "/multitenants/count": { "get": { "x-controller-name": "MultitenantsController", "x-operation-name": "count", "tags": [ "MultitenantsController" ], "responses": { "200": { "description": "Multitenant model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Multitenant.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MultitenantsController.count" } }, "/multitenants/{id}/postal-address": { "patch": { "x-controller-name": "MultitenantsController", "x-operation-name": "updatePostalAddress", "tags": [ "MultitenantsController" ], "responses": { "200": { "description": "Updated tenant with the new postal address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Multitenant" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "postalAddress" ], "properties": { "postalAddress": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "MultitenantsController.updatePostalAddress" } }, "/multitenants/{id}": { "put": { "x-controller-name": "MultitenantsController", "x-operation-name": "replaceById", "tags": [ "MultitenantsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Multitenant PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Multitenant" } } }, "x-parameter-index": 1 }, "operationId": "MultitenantsController.replaceById" }, "patch": { "x-controller-name": "MultitenantsController", "x-operation-name": "updateById", "tags": [ "MultitenantsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Multitenant PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultitenantPartial" } } }, "x-parameter-index": 1 }, "operationId": "MultitenantsController.updateById" }, "get": { "x-controller-name": "MultitenantsController", "x-operation-name": "findById", "tags": [ "MultitenantsController" ], "responses": { "200": { "description": "Multitenant model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultitenantWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Multitenant.Filter" } } } } ], "operationId": "MultitenantsController.findById" }, "delete": { "x-controller-name": "MultitenantsController", "x-operation-name": "deleteById", "tags": [ "MultitenantsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Multitenant DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MultitenantsController.deleteById" } }, "/multitenants": { "post": { "x-controller-name": "MultitenantsController", "x-operation-name": "create", "tags": [ "MultitenantsController" ], "responses": { "200": { "description": "Multitenant model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Multitenant" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMultitenant" } } } }, "operationId": "MultitenantsController.create" }, "patch": { "x-controller-name": "MultitenantsController", "x-operation-name": "updateAll", "tags": [ "MultitenantsController" ], "responses": { "200": { "description": "Multitenant PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Multitenant.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultitenantPartial" } } } }, "operationId": "MultitenantsController.updateAll" }, "get": { "x-controller-name": "MultitenantsController", "x-operation-name": "find", "tags": [ "MultitenantsController" ], "responses": { "200": { "description": "Array of Multitenant model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MultitenantWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Multitenant.Filter1" } } } } ], "operationId": "MultitenantsController.find" } }, "/my/affiliate-payouts": { "get": { "x-controller-name": "AffiliatePayoutsController", "x-operation-name": "myAffiliatePayouts", "tags": [ "AffiliatePayoutsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The caller's own payout destination plus their commission payout history, newest first, with the client-level lines behind each period" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "AffiliatePayoutsController.myAffiliatePayouts" } }, "/my/company-documents/payroll-complete": { "post": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "declareMyPayrollComplete", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "Employer declaration that the payroll document set is complete", "content": { "application/json": { "schema": { "type": "object", "properties": { "payrollSubmissionCompleteAt": { "type": "string", "format": "date-time" }, "payrollDocumentCount": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" } } } } } }, "operationId": "CompanyDocumentsController.declareMyPayrollComplete" } }, "/my/company-documents/payroll-upload": { "post": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "uploadMyPayroll", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "Uploaded payroll document (employer self-upload)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDocument" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CompanyDocumentsController.uploadMyPayroll" } }, "/my/company-documents/{id}/download": { "get": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "downloadMine", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyDocumentsController.downloadMine" } }, "/my/company-documents": { "get": { "x-controller-name": "CompanyDocumentsController", "x-operation-name": "listMine", "tags": [ "CompanyDocumentsController" ], "responses": { "200": { "description": "Employer-visible documents for the caller's own companies, newest first", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "label": { "type": "string" }, "originalFilename": { "type": "string" }, "mimetype": { "type": "string" }, "size": { "type": "number" }, "documentType": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } } } } } } }, "operationId": "CompanyDocumentsController.listMine" } }, "/my/employee-change-requests/{id}/withdraw": { "post": { "x-controller-name": "EmployeeChangeRequestsController", "x-operation-name": "withdrawMine", "tags": [ "EmployeeChangeRequestsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The withdrawn (rejected) request" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployeeChangeRequestsController.withdrawMine" } }, "/my/employee-change-requests": { "post": { "x-controller-name": "EmployeeChangeRequestsController", "x-operation-name": "createMine", "tags": [ "EmployeeChangeRequestsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The created change request" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId", "requestType" ], "properties": { "companyId": { "type": "number" }, "requestType": { "type": "string" }, "employeeName": { "type": "string", "nullable": true }, "details": { "type": "string", "nullable": true }, "effectiveDate": { "type": "string", "nullable": true } } } } } }, "operationId": "EmployeeChangeRequestsController.createMine" }, "get": { "x-controller-name": "EmployeeChangeRequestsController", "x-operation-name": "listMine", "tags": [ "EmployeeChangeRequestsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The company's change requests" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployeeChangeRequestsController.listMine" } }, "/my/employee-documents": { "get": { "x-controller-name": "EmployeeDocumentsController", "x-operation-name": "listMyEmployeeDocuments", "tags": [ "EmployeeDocumentsController" ], "responses": { "200": { "description": "The signed-in employee's own documents, newest first", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "operationId": "EmployeeDocumentsController.listMyEmployeeDocuments" } }, "/my/employee-invitation-groups/{id}": { "patch": { "x-controller-name": "EmployeeInvitationGroupsController", "x-operation-name": "updateMine", "tags": [ "EmployeeInvitationGroupsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The updated invitation group" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "censusEmployeeIds": { "type": "array", "items": { "type": "number" } } } } } }, "x-parameter-index": 1 }, "operationId": "EmployeeInvitationGroupsController.updateMine" }, "delete": { "x-controller-name": "EmployeeInvitationGroupsController", "x-operation-name": "deleteMine", "tags": [ "EmployeeInvitationGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Invitation group deleted" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmployeeInvitationGroupsController.deleteMine" } }, "/my/employee-invitation-groups": { "post": { "x-controller-name": "EmployeeInvitationGroupsController", "x-operation-name": "createMine", "tags": [ "EmployeeInvitationGroupsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The created invitation group" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId", "name", "censusEmployeeIds" ], "properties": { "companyId": { "type": "number" }, "name": { "type": "string" }, "censusEmployeeIds": { "type": "array", "items": { "type": "number" } } } } } } }, "operationId": "EmployeeInvitationGroupsController.createMine" }, "get": { "x-controller-name": "EmployeeInvitationGroupsController", "x-operation-name": "listMine", "tags": [ "EmployeeInvitationGroupsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The company's employee invitation groups" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployeeInvitationGroupsController.listMine" } }, "/my/employee-roster": { "get": { "x-controller-name": "EmployeeRosterController", "x-operation-name": "getMine", "tags": [ "EmployeeRosterController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The company's employee roster (latest census, safe columns)" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } }, { "name": "includeEmail", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeEnrollment", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "EmployeeRosterController.getMine" } }, "/my/employer-savings": { "get": { "x-controller-name": "EmployerSavingsController", "x-operation-name": "myEmployerSavings", "tags": [ "EmployerSavingsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Actual employer FICA savings for a company: current payroll period + YTD" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployerSavingsController.myEmployerSavings" } }, "/my/new-group-info": { "post": { "x-controller-name": "NewGroupInfoController", "x-operation-name": "file", "tags": [ "NewGroupInfoController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Filed New Group Information document" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId", "values" ], "properties": { "companyId": { "type": "number" }, "values": { "type": "object", "maxProperties": 100, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } } } } }, "description": "Company and the completed answers", "required": true }, "operationId": "NewGroupInfoController.file" }, "get": { "x-controller-name": "NewGroupInfoController", "x-operation-name": "filedState", "tags": [ "NewGroupInfoController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Filed state of this company New Group Information form" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "NewGroupInfoController.filedState" } }, "/my/new-hire-pipeline": { "get": { "x-controller-name": "NewHirePipelineController", "x-operation-name": "myNewHirePipeline", "tags": [ "NewHirePipelineController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Employees the payroll connection has detected since the baseline census, newest first, with the connection state behind them" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "NewHirePipelineController.myNewHirePipeline" } }, "/my/pay-comparison-availability": { "get": { "x-controller-name": "EmployerPayComparisonController", "x-operation-name": "availableForMine", "tags": [ "EmployerPayComparisonController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Census employee ids with a downloadable pay comparison" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployerPayComparisonController.availableForMine" } }, "/my/pay-comparison-pdf": { "get": { "x-controller-name": "EmployerPayComparisonController", "x-operation-name": "getMine", "tags": [ "EmployerPayComparisonController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } }, { "name": "censusEmployeeId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployerPayComparisonController.getMine" } }, "/my/payroll-credentials/{id}": { "delete": { "x-controller-name": "PayrollCredentialsController", "x-operation-name": "purgeMine", "tags": [ "PayrollCredentialsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Credential purged" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayrollCredentialsController.purgeMine" } }, "/my/payroll-credentials": { "post": { "x-controller-name": "PayrollCredentialsController", "x-operation-name": "createMine", "tags": [ "PayrollCredentialsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Sanitized stored credential (no secrets)" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId", "method", "username", "password" ], "properties": { "companyId": { "type": "number" }, "method": { "type": "string" }, "provider": { "type": "string", "nullable": true }, "loginUrl": { "type": "string", "nullable": true }, "username": { "type": "string" }, "password": { "type": "string" } } } } } }, "operationId": "PayrollCredentialsController.createMine" }, "get": { "x-controller-name": "PayrollCredentialsController", "x-operation-name": "listMine", "tags": [ "PayrollCredentialsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Active credentials for the company, sanitized" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "PayrollCredentialsController.listMine" } }, "/my/sales-material/{id}/download": { "get": { "x-controller-name": "SalesMaterialController", "x-operation-name": "downloadMine", "tags": [ "SalesMaterialController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SalesMaterialController.downloadMine" } }, "/my/sales-material": { "get": { "x-controller-name": "SalesMaterialController", "x-operation-name": "findMine", "tags": [ "SalesMaterialController" ], "responses": { "200": { "description": "List employer-visible sales material (active only), alphabetical", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesMaterial" } } } } } }, "operationId": "SalesMaterialController.findMine" } }, "/my/savings-reconciliation": { "get": { "x-controller-name": "EmployerReconciliationController", "x-operation-name": "mySavingsReconciliation", "tags": [ "EmployerReconciliationController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-pay-period and monthly reconciliation of S125 deductions, employer FICA savings and program fees, on a named calculation basis" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } }, { "name": "mode", "in": "query", "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployerReconciliationController.mySavingsReconciliation" } }, "/my/savings-reconciliation-pdf": { "get": { "x-controller-name": "EmployerReconciliationController", "x-operation-name": "mySavingsReconciliationPdf", "tags": [ "EmployerReconciliationController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } }, { "name": "mode", "in": "query", "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployerReconciliationController.mySavingsReconciliationPdf" } }, "/my/tpa-invoice-pdf": { "get": { "x-controller-name": "EmployerFinancialsController", "x-operation-name": "downloadMine", "tags": [ "EmployerFinancialsController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } }, { "name": "invoiceId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployerFinancialsController.downloadMine" } }, "/my/tpa-invoices": { "get": { "x-controller-name": "EmployerFinancialsController", "x-operation-name": "listMine", "tags": [ "EmployerFinancialsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Sanitized employer invoices, newest first" } } } } }, "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmployerFinancialsController.listMine" } }, "/my-companies": { "get": { "x-controller-name": "CompaniesController", "x-operation-name": "myCompanies", "tags": [ "CompaniesController" ], "responses": { "200": { "description": "The companies the authenticated user may access (or their ids)", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWithRelations" } }, { "type": "array", "items": { "type": "number" } } ] } } } } }, "parameters": [ { "name": "ids", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.Filter1" } } } } ], "operationId": "CompaniesController.myCompanies" } }, "/my-ip": { "get": { "x-controller-name": "MyIPController", "x-operation-name": "ping", "tags": [ "MyIPController" ], "responses": { "200": { "description": "My IP Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/My IP Response" } } } } }, "operationId": "MyIPController.ping" } }, "/my-logs": { "get": { "x-controller-name": "LogsController", "x-operation-name": "findMy", "tags": [ "LogsController" ], "responses": { "200": { "description": "Array of Log model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Log.Filter1" } } } } ], "operationId": "LogsController.findMy" } }, "/my-transactions": { "get": { "x-controller-name": "TransactionController", "x-operation-name": "findMy", "tags": [ "TransactionController" ], "responses": { "200": { "description": "Array of Transaction model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionWithRelations" } } } } } }, "operationId": "TransactionController.findMy" } }, "/my-users": { "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "findMy", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Array of marshalled ClearErcUser rows (limited by access). Each row's `roleGroups` is always projected to {id, name} — board #3485.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarshalledUserWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Filter" } } } }, { "name": "role", "in": "query", "schema": { "type": "string" } } ], "operationId": "ClearErcUsersController.findMy" } }, "/my-utm-links": { "get": { "x-controller-name": "UtmLinksController", "x-operation-name": "findMy", "tags": [ "UtmLinksController" ], "responses": { "200": { "description": "Array of UtmLinks model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UtmLinksWithRelations" } } } } } }, "operationId": "UtmLinksController.findMy" } }, "/my-utm-logs": { "get": { "x-controller-name": "UtmLogsController", "x-operation-name": "findMy", "tags": [ "UtmLogsController" ], "responses": { "200": { "description": "Array of UtmLog model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UtmLogWithRelations" } } } } } }, "operationId": "UtmLogsController.findMy" } }, "/navigations/count": { "get": { "x-controller-name": "NavigationController", "x-operation-name": "count", "tags": [ "NavigationController" ], "responses": { "200": { "description": "Navigation model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Navigation.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "NavigationController.count" } }, "/navigations/{id}": { "put": { "x-controller-name": "NavigationController", "x-operation-name": "replaceById", "tags": [ "NavigationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Navigation PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Navigation" } } }, "x-parameter-index": 1 }, "operationId": "NavigationController.replaceById" }, "patch": { "x-controller-name": "NavigationController", "x-operation-name": "updateById", "tags": [ "NavigationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Navigation PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NavigationPartial" } } }, "x-parameter-index": 1 }, "operationId": "NavigationController.updateById" }, "get": { "x-controller-name": "NavigationController", "x-operation-name": "findById", "tags": [ "NavigationController" ], "responses": { "200": { "description": "Navigation model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NavigationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Navigation.Filter" } } } } ], "operationId": "NavigationController.findById" }, "delete": { "x-controller-name": "NavigationController", "x-operation-name": "deleteById", "tags": [ "NavigationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Navigation DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NavigationController.deleteById" } }, "/navigations": { "post": { "x-controller-name": "NavigationController", "x-operation-name": "create", "tags": [ "NavigationController" ], "responses": { "200": { "description": "Navigation model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Navigation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewNavigation" } } } }, "operationId": "NavigationController.create" }, "patch": { "x-controller-name": "NavigationController", "x-operation-name": "updateAll", "tags": [ "NavigationController" ], "responses": { "200": { "description": "Navigation PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Navigation.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NavigationPartial" } } } }, "operationId": "NavigationController.updateAll" }, "get": { "x-controller-name": "NavigationController", "x-operation-name": "find", "tags": [ "NavigationController" ], "responses": { "200": { "description": "Array of Navigation model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NavigationWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Navigation.Filter1" } } } } ], "operationId": "NavigationController.find" } }, "/new-group-info/schema": { "get": { "x-controller-name": "NewGroupInfoController", "x-operation-name": "schema", "tags": [ "NewGroupInfoController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "New Group Information form definition" } } } } }, "operationId": "NewGroupInfoController.schema" } }, "/noauth-user/{id}": { "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "noAuthUserById", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Minimal setup identity ({name, email}) for the token-authorized user", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "verificationToken", "in": "query", "schema": { "type": "string" } } ], "operationId": "ClearErcUsersController.noAuthUserById" } }, "/notifications/count": { "get": { "x-controller-name": "NotificationController", "x-operation-name": "count", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Notification model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Notification.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "NotificationController.count" } }, "/notifications/{id}": { "put": { "x-controller-name": "NotificationController", "x-operation-name": "replaceById", "tags": [ "NotificationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Notification PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "x-parameter-index": 1 }, "operationId": "NotificationController.replaceById" }, "patch": { "x-controller-name": "NotificationController", "x-operation-name": "updateById", "tags": [ "NotificationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Notification PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationPartial" } } }, "x-parameter-index": 1 }, "operationId": "NotificationController.updateById" }, "get": { "x-controller-name": "NotificationController", "x-operation-name": "findById", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Notification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification.Filter" } } } } ], "operationId": "NotificationController.findById" }, "delete": { "x-controller-name": "NotificationController", "x-operation-name": "deleteById", "tags": [ "NotificationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Notification DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NotificationController.deleteById" } }, "/notifications": { "post": { "x-controller-name": "NotificationController", "x-operation-name": "create", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Notification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewNotification" } } } }, "operationId": "NotificationController.create" }, "patch": { "x-controller-name": "NotificationController", "x-operation-name": "updateAll", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Notification PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Notification.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationPartial" } } } }, "operationId": "NotificationController.updateAll" }, "get": { "x-controller-name": "NotificationController", "x-operation-name": "find", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Array of Notification model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification.Filter1" } } } } ], "operationId": "NotificationController.find" } }, "/ocr-census/extract": { "post": { "x-controller-name": "OcrCensusController", "x-operation-name": "extract", "tags": [ "OcrCensusController" ], "responses": { "200": { "description": "Census rows read off a payroll register PDF (nothing is stored)", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentName": { "type": "string" }, "pageCount": { "type": "number" }, "detectedDocumentType": { "type": "string" }, "payPeriodLabel": { "type": "string" }, "extractedAt": { "type": "string" }, "employees": { "type": "array", "items": { "type": "object" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OcrCensusExtractRequest" } } } }, "operationId": "OcrCensusController.extract" } }, "/order-files/count": { "get": { "x-controller-name": "FilesController", "x-operation-name": "count", "tags": [ "FilesController" ], "responses": { "200": { "description": "Files model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Files.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FilesController.count" } }, "/order-files/{id}": { "put": { "x-controller-name": "FilesController", "x-operation-name": "replaceById", "tags": [ "FilesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Files PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Files" } } }, "x-parameter-index": 1 }, "operationId": "FilesController.replaceById" }, "patch": { "x-controller-name": "FilesController", "x-operation-name": "updateById", "tags": [ "FilesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Files PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesPartial" } } }, "x-parameter-index": 1 }, "operationId": "FilesController.updateById" }, "get": { "x-controller-name": "FilesController", "x-operation-name": "findById", "tags": [ "FilesController" ], "responses": { "200": { "description": "Files model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Files.Filter" } } } } ], "operationId": "FilesController.findById" }, "delete": { "x-controller-name": "FilesController", "x-operation-name": "deleteById", "tags": [ "FilesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Files DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FilesController.deleteById" } }, "/orders/count": { "get": { "x-controller-name": "OrdersController", "x-operation-name": "count", "tags": [ "OrdersController" ], "responses": { "200": { "description": "Orders model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Orders.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "OrdersController.count" } }, "/orders/{id}": { "put": { "x-controller-name": "OrdersController", "x-operation-name": "replaceById", "tags": [ "OrdersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Orders PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } }, "x-parameter-index": 1 }, "operationId": "OrdersController.replaceById" }, "patch": { "x-controller-name": "OrdersController", "x-operation-name": "updateById", "tags": [ "OrdersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Orders PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrdersPartial" } } }, "x-parameter-index": 1 }, "operationId": "OrdersController.updateById" }, "get": { "x-controller-name": "OrdersController", "x-operation-name": "findById", "tags": [ "OrdersController" ], "responses": { "200": { "description": "Orders model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrdersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders.Filter" } } } } ], "operationId": "OrdersController.findById" }, "delete": { "x-controller-name": "OrdersController", "x-operation-name": "deleteById", "tags": [ "OrdersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Orders DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "OrdersController.deleteById" } }, "/orders": { "post": { "x-controller-name": "OrdersController", "x-operation-name": "create", "tags": [ "OrdersController" ], "responses": { "200": { "description": "Orders model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewOrders" } } } }, "operationId": "OrdersController.create" }, "patch": { "x-controller-name": "OrdersController", "x-operation-name": "updateAll", "tags": [ "OrdersController" ], "responses": { "200": { "description": "Orders PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Orders.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrdersPartial" } } } }, "operationId": "OrdersController.updateAll" }, "get": { "x-controller-name": "OrdersController", "x-operation-name": "find", "tags": [ "OrdersController" ], "responses": { "200": { "description": "Array of Orders model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrdersWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders.Filter1" } } } } ], "operationId": "OrdersController.find" } }, "/outbound-tasks/{id}/delegates/{userId}": { "delete": { "x-controller-name": "OutboundTaskController", "x-operation-name": "removeDelegate", "tags": [ "OutboundTaskController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Remove a delegate from an outbound task" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "OutboundTaskController.removeDelegate" } }, "/outbound-tasks/{id}/delegates": { "post": { "x-controller-name": "OutboundTaskController", "x-operation-name": "addDelegate", "tags": [ "OutboundTaskController" ], "responses": { "200": { "description": "Delegate an outbound task to a user (idempotent)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundTaskDelegates" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOutboundTaskDelegate" } } }, "x-parameter-index": 1 }, "operationId": "OutboundTaskController.addDelegate" }, "get": { "x-controller-name": "OutboundTaskController", "x-operation-name": "findDelegates", "tags": [ "OutboundTaskController" ], "responses": { "200": { "description": "List the delegates of an outbound task", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OutboundTaskDelegates" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "OutboundTaskController.findDelegates" } }, "/outbound-tasks/{id}/status": { "patch": { "x-controller-name": "OutboundTaskController", "x-operation-name": "updateStatusById", "tags": [ "OutboundTaskController" ], "responses": { "200": { "description": "Transition an outbound task to a new status (enforced server-side)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundTask" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOutboundTaskStatus" } } }, "x-parameter-index": 1 }, "operationId": "OutboundTaskController.updateStatusById" } }, "/outbound-tasks/{id}": { "patch": { "x-controller-name": "OutboundTaskController", "x-operation-name": "updateById", "tags": [ "OutboundTaskController" ], "responses": { "200": { "description": "Edit an outbound task (title/description/assignee/dueAt/channel)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundTask" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOutboundTask" } } }, "x-parameter-index": 1 }, "operationId": "OutboundTaskController.updateById" }, "get": { "x-controller-name": "OutboundTaskController", "x-operation-name": "findById", "tags": [ "OutboundTaskController" ], "responses": { "200": { "description": "Get an outbound task by id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundTask" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "OutboundTaskController.findById" }, "delete": { "x-controller-name": "OutboundTaskController", "x-operation-name": "deleteById", "tags": [ "OutboundTaskController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete an outbound task" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "OutboundTaskController.deleteById" } }, "/outbound-tasks": { "post": { "x-controller-name": "OutboundTaskController", "x-operation-name": "create", "tags": [ "OutboundTaskController" ], "responses": { "200": { "description": "Create an outbound task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundTask" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewOutboundTask" } } } }, "operationId": "OutboundTaskController.create" }, "get": { "x-controller-name": "OutboundTaskController", "x-operation-name": "find", "tags": [ "OutboundTaskController" ], "responses": { "200": { "description": "List outbound tasks (scoped to the caller)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OutboundTask" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundTask.Filter" } } } }, { "name": "mine", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "OutboundTaskController.find" } }, "/package-section-rules/count": { "get": { "x-controller-name": "PackageSectionRulesController", "x-operation-name": "count", "tags": [ "PackageSectionRulesController" ], "responses": { "200": { "description": "PackageSectionRules model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PackageSectionRules.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PackageSectionRulesController.count" } }, "/package-section-rules/{id}": { "put": { "x-controller-name": "PackageSectionRulesController", "x-operation-name": "replaceById", "tags": [ "PackageSectionRulesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PackageSectionRules PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageSectionRules" } } }, "x-parameter-index": 1 }, "operationId": "PackageSectionRulesController.replaceById" }, "patch": { "x-controller-name": "PackageSectionRulesController", "x-operation-name": "updateById", "tags": [ "PackageSectionRulesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PackageSectionRules PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageSectionRulesPartial" } } }, "x-parameter-index": 1 }, "operationId": "PackageSectionRulesController.updateById" }, "get": { "x-controller-name": "PackageSectionRulesController", "x-operation-name": "findById", "tags": [ "PackageSectionRulesController" ], "responses": { "200": { "description": "PackageSectionRules model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageSectionRulesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageSectionRules.Filter" } } } } ], "operationId": "PackageSectionRulesController.findById" }, "delete": { "x-controller-name": "PackageSectionRulesController", "x-operation-name": "deleteById", "tags": [ "PackageSectionRulesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PackageSectionRules DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PackageSectionRulesController.deleteById" } }, "/package-section-rules": { "post": { "x-controller-name": "PackageSectionRulesController", "x-operation-name": "create", "tags": [ "PackageSectionRulesController" ], "responses": { "200": { "description": "PackageSectionRules model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageSectionRules" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPackageSectionRules" } } } }, "operationId": "PackageSectionRulesController.create" }, "patch": { "x-controller-name": "PackageSectionRulesController", "x-operation-name": "updateAll", "tags": [ "PackageSectionRulesController" ], "responses": { "200": { "description": "PackageSectionRules PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PackageSectionRules.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageSectionRulesPartial" } } } }, "operationId": "PackageSectionRulesController.updateAll" }, "get": { "x-controller-name": "PackageSectionRulesController", "x-operation-name": "find", "tags": [ "PackageSectionRulesController" ], "responses": { "200": { "description": "Array of PackageSectionRules model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PackageSectionRulesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageSectionRules.Filter1" } } } } ], "operationId": "PackageSectionRulesController.find" } }, "/payment-intents/count": { "get": { "x-controller-name": "PaymentIntentsController", "x-operation-name": "count", "tags": [ "PaymentIntentsController" ], "responses": { "200": { "description": "PaymentIntents model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PaymentIntents.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PaymentIntentsController.count" } }, "/payment-intents/{id}": { "put": { "x-controller-name": "PaymentIntentsController", "x-operation-name": "replaceById", "tags": [ "PaymentIntentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PaymentIntents PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntents" } } }, "x-parameter-index": 1 }, "operationId": "PaymentIntentsController.replaceById" }, "patch": { "x-controller-name": "PaymentIntentsController", "x-operation-name": "updateById", "tags": [ "PaymentIntentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PaymentIntents PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentsPartial" } } }, "x-parameter-index": 1 }, "operationId": "PaymentIntentsController.updateById" }, "get": { "x-controller-name": "PaymentIntentsController", "x-operation-name": "findById", "tags": [ "PaymentIntentsController" ], "responses": { "200": { "description": "PaymentIntents model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntents.Filter" } } } } ], "operationId": "PaymentIntentsController.findById" }, "delete": { "x-controller-name": "PaymentIntentsController", "x-operation-name": "deleteById", "tags": [ "PaymentIntentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PaymentIntents DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PaymentIntentsController.deleteById" } }, "/payment-intents": { "post": { "x-controller-name": "PaymentIntentsController", "x-operation-name": "create", "tags": [ "PaymentIntentsController" ], "responses": { "200": { "description": "PaymentIntents model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntents" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPaymentIntents" } } } }, "operationId": "PaymentIntentsController.create" }, "patch": { "x-controller-name": "PaymentIntentsController", "x-operation-name": "updateAll", "tags": [ "PaymentIntentsController" ], "responses": { "200": { "description": "PaymentIntents PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PaymentIntents.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentsPartial" } } } }, "operationId": "PaymentIntentsController.updateAll" }, "get": { "x-controller-name": "PaymentIntentsController", "x-operation-name": "find", "tags": [ "PaymentIntentsController" ], "responses": { "200": { "description": "Array of PaymentIntents model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntentsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntents.Filter1" } } } } ], "operationId": "PaymentIntentsController.find" } }, "/payments/count": { "get": { "x-controller-name": "PaymentController", "x-operation-name": "count", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Payment model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Payment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PaymentController.count" } }, "/payments/recipient-balances": { "get": { "x-controller-name": "PaymentController", "x-operation-name": "recipientBalances", "tags": [ "PaymentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-recipient owed/paid/outstanding balances" } } } } }, "operationId": "PaymentController.recipientBalances" } }, "/payments/w9-missing": { "get": { "x-controller-name": "PaymentController", "x-operation-name": "w9Missing", "tags": [ "PaymentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Companies paid by wire but with no W-9 on file" } } } } }, "operationId": "PaymentController.w9Missing" } }, "/payments/{id}/confirm": { "post": { "x-controller-name": "PaymentController", "x-operation-name": "confirm", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Confirmed Payment instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "wireTraceNumber": { "type": "string" }, "method": { "type": "string" }, "confirmedAt": { "type": "string", "format": "date-time" } } } } }, "x-parameter-index": 1 }, "operationId": "PaymentController.confirm" } }, "/payments/{id}/confirmation-files/{fileId}": { "delete": { "x-controller-name": "PaymentController", "x-operation-name": "detachConfirmationFile", "tags": [ "PaymentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Confirmation file detached" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "fileId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PaymentController.detachConfirmationFile" } }, "/payments/{id}/confirmation-files": { "post": { "x-controller-name": "PaymentController", "x-operation-name": "attachConfirmationFiles", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Updated list of attached FileUploads", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileUploads" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "fileUploadIds" ], "properties": { "fileUploadIds": { "type": "array", "items": { "type": "number" } } } } } }, "x-parameter-index": 1 }, "operationId": "PaymentController.attachConfirmationFiles" }, "get": { "x-controller-name": "PaymentController", "x-operation-name": "getConfirmationFiles", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Array of FileUploads attached to the payment", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileUploads" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PaymentController.getConfirmationFiles" } }, "/payments/{id}/transactions/{transactionId}": { "delete": { "x-controller-name": "PaymentController", "x-operation-name": "detachTransaction", "tags": [ "PaymentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Coverage after detach" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "transactionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PaymentController.detachTransaction" } }, "/payments/{id}/transactions": { "post": { "x-controller-name": "PaymentController", "x-operation-name": "attachTransactions", "tags": [ "PaymentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Attach result + coverage" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "transactionIds" ], "properties": { "transactionIds": { "type": "array", "items": { "type": "string" } } } } } }, "x-parameter-index": 1 }, "operationId": "PaymentController.attachTransactions" }, "get": { "x-controller-name": "PaymentController", "x-operation-name": "getLinkedTransactions", "tags": [ "PaymentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Linked transactions + coverage" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PaymentController.getLinkedTransactions" } }, "/payments/{id}/void": { "post": { "x-controller-name": "PaymentController", "x-operation-name": "void", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Voided Payment instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string" } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "PaymentController.void" } }, "/payments/{id}": { "put": { "x-controller-name": "PaymentController", "x-operation-name": "replaceById", "tags": [ "PaymentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Payment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } }, "x-parameter-index": 1 }, "operationId": "PaymentController.replaceById" }, "patch": { "x-controller-name": "PaymentController", "x-operation-name": "updateById", "tags": [ "PaymentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Payment PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentPartial" } } }, "x-parameter-index": 1 }, "operationId": "PaymentController.updateById" }, "get": { "x-controller-name": "PaymentController", "x-operation-name": "findById", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Payment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.Filter" } } } } ], "operationId": "PaymentController.findById" }, "delete": { "x-controller-name": "PaymentController", "x-operation-name": "deleteById", "tags": [ "PaymentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Payment DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PaymentController.deleteById" } }, "/payments": { "post": { "x-controller-name": "PaymentController", "x-operation-name": "create", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Payment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPayment" } } } }, "operationId": "PaymentController.create" }, "patch": { "x-controller-name": "PaymentController", "x-operation-name": "updateAll", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Payment PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Payment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentPartial" } } } }, "operationId": "PaymentController.updateAll" }, "get": { "x-controller-name": "PaymentController", "x-operation-name": "find", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Array of Payment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.Filter1" } } } } ], "operationId": "PaymentController.find" } }, "/payments-new/count": { "get": { "x-controller-name": "PaymentsNewController", "x-operation-name": "count", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "PaymentNew count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PaymentNew.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PaymentsNewController.count" } }, "/payments-new/{id}/allocations/{allocationId}": { "delete": { "x-controller-name": "PaymentsNewController", "x-operation-name": "deallocate", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "The allocation, now marked reversed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentAllocation" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "allocationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PaymentsNewController.deallocate" } }, "/payments-new/{id}/allocations": { "post": { "x-controller-name": "PaymentsNewController", "x-operation-name": "allocate", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "The created allocations", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAllocation" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "allocations" ], "properties": { "allocations": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "transactionNewId", "amount" ], "properties": { "transactionNewId": { "type": "string" }, "amount": { "type": "number" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "PaymentsNewController.allocate" }, "get": { "x-controller-name": "PaymentsNewController", "x-operation-name": "listAllocations", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "The payment's allocations (reversed rows included, marked by reversedByEventId)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAllocation" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PaymentsNewController.listAllocations" } }, "/payments-new/{id}/confirm": { "post": { "x-controller-name": "PaymentsNewController", "x-operation-name": "confirm", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "The confirmed payment (settlement legs posted)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentNew" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "traceNumber": { "type": "string" }, "processorRef": { "type": "string" }, "confirmedAt": { "type": "string", "format": "date-time" } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "PaymentsNewController.confirm" } }, "/payments-new/{id}/initiate": { "post": { "x-controller-name": "PaymentsNewController", "x-operation-name": "initiate", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "The payment, moved to initiated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentNew" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PaymentsNewController.initiate" } }, "/payments-new/{id}/send": { "post": { "x-controller-name": "PaymentsNewController", "x-operation-name": "send", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "The payment, moved to sent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentNew" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "traceNumber": { "type": "string" } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "PaymentsNewController.send" } }, "/payments-new/{id}/void": { "post": { "x-controller-name": "PaymentsNewController", "x-operation-name": "void", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "The voided payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentNew" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "reason" ], "properties": { "reason": { "type": "string", "minLength": 1 } } } } }, "x-parameter-index": 1 }, "operationId": "PaymentsNewController.void" } }, "/payments-new/{id}": { "get": { "x-controller-name": "PaymentsNewController", "x-operation-name": "findById", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "A PaymentNew instance with its billing-event timeline", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaymentNewWithRelations" }, { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/BillingEvent" } } } } ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PaymentsNewController.findById" } }, "/payments-new": { "post": { "x-controller-name": "PaymentsNewController", "x-operation-name": "create", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "The recorded money movement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentNew" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPaymentNew" } } } }, "operationId": "PaymentsNewController.create" }, "get": { "x-controller-name": "PaymentsNewController", "x-operation-name": "find", "tags": [ "PaymentsNewController" ], "responses": { "200": { "description": "Array of PaymentNew instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentNewWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentNew.Filter" } } } } ], "operationId": "PaymentsNewController.find" } }, "/payout-paperwork-overrides/count": { "get": { "x-controller-name": "PayoutPaperworkOverrideController", "x-operation-name": "count", "tags": [ "PayoutPaperworkOverrideController" ], "responses": { "200": { "description": "PayoutPaperworkOverride model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PayoutPaperworkOverride.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PayoutPaperworkOverrideController.count" } }, "/payout-paperwork-overrides/{id}": { "get": { "x-controller-name": "PayoutPaperworkOverrideController", "x-operation-name": "findById", "tags": [ "PayoutPaperworkOverrideController" ], "responses": { "200": { "description": "PayoutPaperworkOverride model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutPaperworkOverrideWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutPaperworkOverride.Filter" } } } } ], "operationId": "PayoutPaperworkOverrideController.findById" } }, "/payout-paperwork-overrides": { "get": { "x-controller-name": "PayoutPaperworkOverrideController", "x-operation-name": "find", "tags": [ "PayoutPaperworkOverrideController" ], "responses": { "200": { "description": "Array of PayoutPaperworkOverride model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayoutPaperworkOverrideWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutPaperworkOverride.Filter1" } } } } ], "operationId": "PayoutPaperworkOverrideController.find" } }, "/payroll-contacts/count": { "get": { "x-controller-name": "PayrollContactsController", "x-operation-name": "count", "tags": [ "PayrollContactsController" ], "responses": { "200": { "description": "PayrollContact model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PayrollContact.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PayrollContactsController.count" } }, "/payroll-contacts/{id}": { "put": { "x-controller-name": "PayrollContactsController", "x-operation-name": "replaceById", "tags": [ "PayrollContactsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PayrollContact PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollContact" } } }, "x-parameter-index": 1 }, "operationId": "PayrollContactsController.replaceById" }, "patch": { "x-controller-name": "PayrollContactsController", "x-operation-name": "updateById", "tags": [ "PayrollContactsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PayrollContact PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollContactPartial" } } }, "x-parameter-index": 1 }, "operationId": "PayrollContactsController.updateById" }, "get": { "x-controller-name": "PayrollContactsController", "x-operation-name": "findById", "tags": [ "PayrollContactsController" ], "responses": { "200": { "description": "PayrollContact model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollContactWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollContact.Filter" } } } } ], "operationId": "PayrollContactsController.findById" }, "delete": { "x-controller-name": "PayrollContactsController", "x-operation-name": "deleteById", "tags": [ "PayrollContactsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PayrollContact DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayrollContactsController.deleteById" } }, "/payroll-contacts": { "post": { "x-controller-name": "PayrollContactsController", "x-operation-name": "create", "tags": [ "PayrollContactsController" ], "responses": { "200": { "description": "PayrollContact model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollContact" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPayrollContact" } } } }, "operationId": "PayrollContactsController.create" }, "patch": { "x-controller-name": "PayrollContactsController", "x-operation-name": "updateAll", "tags": [ "PayrollContactsController" ], "responses": { "200": { "description": "PayrollContact PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PayrollContact.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollContactPartial" } } } }, "operationId": "PayrollContactsController.updateAll" }, "get": { "x-controller-name": "PayrollContactsController", "x-operation-name": "find", "tags": [ "PayrollContactsController" ], "responses": { "200": { "description": "Array of PayrollContact model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollContactWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollContact.Filter1" } } } } ], "operationId": "PayrollContactsController.find" } }, "/payroll-credentials/{id}/reveal": { "post": { "x-controller-name": "PayrollCredentialsController", "x-operation-name": "reveal", "tags": [ "PayrollCredentialsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Decrypted credential (staff only, audit-logged)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayrollCredentialsController.reveal" } }, "/payroll-data-collections/{id}": { "patch": { "x-controller-name": "PayrollDataCollectionsController", "x-operation-name": "updateById", "tags": [ "PayrollDataCollectionsController" ], "responses": { "200": { "description": "The updated payroll-data collection period", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "method": { "type": "string", "nullable": true }, "status": { "type": "string" }, "note": { "type": "string", "nullable": true }, "dataReceivedAt": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "PayrollDataCollectionsController.updateById" } }, "/pending-elections/mine": { "get": { "x-controller-name": "PendingElectionsController", "x-operation-name": "mine", "tags": [ "PendingElectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The caller's own staged elections, newest first" } } } } }, "operationId": "PendingElectionsController.mine" } }, "/pending-elections/{id}/accept": { "post": { "x-controller-name": "PendingElectionsController", "x-operation-name": "accept", "tags": [ "PendingElectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The accepted election and the span it opened" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PendingElectionsController.accept" } }, "/pending-elections/{id}/decline": { "post": { "x-controller-name": "PendingElectionsController", "x-operation-name": "decline", "tags": [ "PendingElectionsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The declined election" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PendingElectionsController.decline" } }, "/period-eligibility-decisions/{id}/preview-correction": { "post": { "x-controller-name": "PeriodEligibilityReviewController", "x-operation-name": "previewCorrection", "tags": [ "PeriodEligibilityReviewController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Recompute one decision row`s eligibility band + qualification verdict under a corrected set of trailing hours, WITHOUT committing anything (super-user only). Powers the staff \"Correct hours\" what-if." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "correctedHours" ], "properties": { "correctedHours": { "type": "array", "items": { "type": "number" } } }, "additionalProperties": false } } }, "required": true, "x-parameter-index": 1 }, "operationId": "PeriodEligibilityReviewController.previewCorrection" } }, "/period-eligibility-decisions/{id}/resolve": { "post": { "x-controller-name": "PeriodEligibilityReviewController", "x-operation-name": "resolve", "tags": [ "PeriodEligibilityReviewController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Resolve a review-queue row by appending a staff clear/skip decision that supersedes it (super-user only)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "clear", "skip" ] } }, "additionalProperties": false } } }, "required": true, "x-parameter-index": 1 }, "operationId": "PeriodEligibilityReviewController.resolve" } }, "/period-eligibility-review": { "get": { "x-controller-name": "PeriodEligibilityReviewController", "x-operation-name": "list", "tags": [ "PeriodEligibilityReviewController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The current per-period eligibility review queue: the latest decision per (individual, period) whose latest verdict is still `review` (super-user only)" } } } } }, "operationId": "PeriodEligibilityReviewController.list" } }, "/ping": { "get": { "x-controller-name": "PingController", "x-operation-name": "ping", "tags": [ "PingController" ], "responses": { "200": { "description": "Ping Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingResponse" } } } } }, "operationId": "PingController.ping" } }, "/process-mandates/{id}": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "processMandateEndpoint", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Return value of ClearErcUsersController.processMandateEndpoint" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ClearErcUsersController.processMandateEndpoint" } }, "/process-mandates": { "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "processMandatesEndpoint", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Return value of ClearErcUsersController.processMandatesEndpoint" } }, "operationId": "ClearErcUsersController.processMandatesEndpoint" } }, "/processflow-group-role-groups/count": { "get": { "x-controller-name": "ProcessflowGroupRoleGroupsController", "x-operation-name": "count", "tags": [ "ProcessflowGroupRoleGroupsController" ], "responses": { "200": { "description": "ProcessflowGroupRoleGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowGroupRoleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowGroupRoleGroupsController.count" } }, "/processflow-group-role-groups/{id}": { "put": { "x-controller-name": "ProcessflowGroupRoleGroupsController", "x-operation-name": "replaceById", "tags": [ "ProcessflowGroupRoleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowGroupRoleGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupRoleGroups" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowGroupRoleGroupsController.replaceById" }, "patch": { "x-controller-name": "ProcessflowGroupRoleGroupsController", "x-operation-name": "updateById", "tags": [ "ProcessflowGroupRoleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowGroupRoleGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupRoleGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowGroupRoleGroupsController.updateById" }, "get": { "x-controller-name": "ProcessflowGroupRoleGroupsController", "x-operation-name": "findById", "tags": [ "ProcessflowGroupRoleGroupsController" ], "responses": { "200": { "description": "ProcessflowGroupRoleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupRoleGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupRoleGroups.Filter" } } } } ], "operationId": "ProcessflowGroupRoleGroupsController.findById" }, "delete": { "x-controller-name": "ProcessflowGroupRoleGroupsController", "x-operation-name": "deleteById", "tags": [ "ProcessflowGroupRoleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowGroupRoleGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProcessflowGroupRoleGroupsController.deleteById" } }, "/processflow-group-role-groups": { "post": { "x-controller-name": "ProcessflowGroupRoleGroupsController", "x-operation-name": "create", "tags": [ "ProcessflowGroupRoleGroupsController" ], "responses": { "200": { "description": "ProcessflowGroupRoleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupRoleGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessflowGroupRoleGroups" } } } }, "operationId": "ProcessflowGroupRoleGroupsController.create" }, "patch": { "x-controller-name": "ProcessflowGroupRoleGroupsController", "x-operation-name": "updateAll", "tags": [ "ProcessflowGroupRoleGroupsController" ], "responses": { "200": { "description": "ProcessflowGroupRoleGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowGroupRoleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupRoleGroupsPartial" } } } }, "operationId": "ProcessflowGroupRoleGroupsController.updateAll" }, "get": { "x-controller-name": "ProcessflowGroupRoleGroupsController", "x-operation-name": "find", "tags": [ "ProcessflowGroupRoleGroupsController" ], "responses": { "200": { "description": "Array of ProcessflowGroupRoleGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessflowGroupRoleGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupRoleGroups.Filter1" } } } } ], "operationId": "ProcessflowGroupRoleGroupsController.find" }, "delete": { "x-controller-name": "ProcessflowGroupRoleGroupsController", "x-operation-name": "deleteWhere", "tags": [ "ProcessflowGroupRoleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Processflow DELETE success" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowGroupRoleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowGroupRoleGroupsController.deleteWhere" } }, "/processflow-groups/count": { "get": { "x-controller-name": "ProcessflowGroupController", "x-operation-name": "count", "tags": [ "ProcessflowGroupController" ], "responses": { "200": { "description": "ProcessflowGroup model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowGroupController.count" } }, "/processflow-groups/{id}/duplicate": { "post": { "x-controller-name": "ProcessflowGroupController", "x-operation-name": "duplicate", "tags": [ "ProcessflowGroupController" ], "responses": { "200": { "description": "ProcessflowGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroup" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessflowGroup" } } } }, "operationId": "ProcessflowGroupController.duplicate" } }, "/processflow-groups/{id}/processflows": { "post": { "x-controller-name": "ProcessflowGroupProcessflowController", "x-operation-name": "create", "tags": [ "ProcessflowGroupProcessflowController" ], "responses": { "200": { "description": "ProcessflowGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Processflow" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessflowInProcessflowGroup" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowGroupProcessflowController.create" }, "patch": { "x-controller-name": "ProcessflowGroupProcessflowController", "x-operation-name": "patch", "tags": [ "ProcessflowGroupProcessflowController" ], "responses": { "200": { "description": "ProcessflowGroup.Processflow PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Processflow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowGroupProcessflowController.patch" }, "get": { "x-controller-name": "ProcessflowGroupProcessflowController", "x-operation-name": "find", "tags": [ "ProcessflowGroupProcessflowController" ], "responses": { "200": { "description": "Array of ProcessflowGroup has many Processflow", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Processflow" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ProcessflowGroupProcessflowController.find" }, "delete": { "x-controller-name": "ProcessflowGroupProcessflowController", "x-operation-name": "delete", "tags": [ "ProcessflowGroupProcessflowController" ], "responses": { "200": { "description": "ProcessflowGroup.Processflow DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Processflow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowGroupProcessflowController.delete" } }, "/processflow-groups/{id}/roles": { "post": { "x-controller-name": "ProcessflowGroupRolesController", "x-operation-name": "create", "tags": [ "ProcessflowGroupRolesController" ], "responses": { "200": { "description": "create a Roles model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRolesInProcessflowGroup" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowGroupRolesController.create" }, "patch": { "x-controller-name": "ProcessflowGroupRolesController", "x-operation-name": "patch", "tags": [ "ProcessflowGroupRolesController" ], "responses": { "200": { "description": "ProcessflowGroup.Roles PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Roles.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowGroupRolesController.patch" }, "get": { "x-controller-name": "ProcessflowGroupRolesController", "x-operation-name": "find", "tags": [ "ProcessflowGroupRolesController" ], "responses": { "200": { "description": "Array of ProcessflowGroup has many Roles through ProcessflowGroupRoles", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Roles" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ProcessflowGroupRolesController.find" }, "delete": { "x-controller-name": "ProcessflowGroupRolesController", "x-operation-name": "delete", "tags": [ "ProcessflowGroupRolesController" ], "responses": { "200": { "description": "ProcessflowGroup.Roles DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Roles.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowGroupRolesController.delete" } }, "/processflow-groups/{id}": { "put": { "x-controller-name": "ProcessflowGroupController", "x-operation-name": "replaceById", "tags": [ "ProcessflowGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowGroup PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroup" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowGroupController.replaceById" }, "patch": { "x-controller-name": "ProcessflowGroupController", "x-operation-name": "updateById", "tags": [ "ProcessflowGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowGroup PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowGroupController.updateById" }, "get": { "x-controller-name": "ProcessflowGroupController", "x-operation-name": "findById", "tags": [ "ProcessflowGroupController" ], "responses": { "200": { "description": "ProcessflowGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroup.Filter" } } } } ], "operationId": "ProcessflowGroupController.findById" }, "delete": { "x-controller-name": "ProcessflowGroupController", "x-operation-name": "deleteById", "tags": [ "ProcessflowGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowGroup DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProcessflowGroupController.deleteById" } }, "/processflow-groups": { "post": { "x-controller-name": "ProcessflowGroupController", "x-operation-name": "create", "tags": [ "ProcessflowGroupController" ], "responses": { "200": { "description": "ProcessflowGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroup" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessflowGroup" } } } }, "operationId": "ProcessflowGroupController.create" }, "patch": { "x-controller-name": "ProcessflowGroupController", "x-operation-name": "updateAll", "tags": [ "ProcessflowGroupController" ], "responses": { "200": { "description": "ProcessflowGroup PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupPartial" } } } }, "operationId": "ProcessflowGroupController.updateAll" }, "get": { "x-controller-name": "ProcessflowGroupController", "x-operation-name": "find", "tags": [ "ProcessflowGroupController" ], "responses": { "200": { "description": "Array of ProcessflowGroup model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessflowGroupWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroup.Filter1" } } } } ], "operationId": "ProcessflowGroupController.find" } }, "/processflow-progresses/count": { "get": { "x-controller-name": "ProcessflowProgressController", "x-operation-name": "count", "tags": [ "ProcessflowProgressController" ], "responses": { "200": { "description": "ProcessflowProgress model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowProgress.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowProgressController.count" } }, "/processflow-progresses/{id}/contract-token": { "get": { "x-controller-name": "ProcessflowProgressController", "x-operation-name": "contractToken", "tags": [ "ProcessflowProgressController" ], "responses": { "200": { "description": "Short-lived capability token for rendering this flow’s signed contract", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "contractType", "in": "query", "schema": { "type": "string" } } ], "operationId": "ProcessflowProgressController.contractToken" } }, "/processflow-progresses/{id}": { "put": { "x-controller-name": "ProcessflowProgressController", "x-operation-name": "replaceById", "tags": [ "ProcessflowProgressController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowProgress PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowProgress" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowProgressController.replaceById" }, "patch": { "x-controller-name": "ProcessflowProgressController", "x-operation-name": "updateById", "tags": [ "ProcessflowProgressController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowProgress PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowProgressPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowProgressController.updateById" }, "get": { "x-controller-name": "ProcessflowProgressController", "x-operation-name": "findById", "tags": [ "ProcessflowProgressController" ], "responses": { "200": { "description": "ProcessflowProgress model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowProgressWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowProgress.Filter" } } } } ], "operationId": "ProcessflowProgressController.findById" }, "delete": { "x-controller-name": "ProcessflowProgressController", "x-operation-name": "deleteById", "tags": [ "ProcessflowProgressController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowProgress DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProcessflowProgressController.deleteById" } }, "/processflow-progresses": { "post": { "x-controller-name": "ProcessflowProgressController", "x-operation-name": "create", "tags": [ "ProcessflowProgressController" ], "responses": { "200": { "description": "ProcessflowProgress model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowProgress" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessflowProgress" } } } }, "operationId": "ProcessflowProgressController.create" }, "patch": { "x-controller-name": "ProcessflowProgressController", "x-operation-name": "updateAll", "tags": [ "ProcessflowProgressController" ], "responses": { "200": { "description": "ProcessflowProgress PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowProgress.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowProgressPartial" } } } }, "operationId": "ProcessflowProgressController.updateAll" }, "get": { "x-controller-name": "ProcessflowProgressController", "x-operation-name": "find", "tags": [ "ProcessflowProgressController" ], "responses": { "200": { "description": "Array of ProcessflowProgress model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessflowProgressWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowProgress.Filter1" } } } } ], "operationId": "ProcessflowProgressController.find" } }, "/processflow-rule-groups/count": { "get": { "x-controller-name": "ProcessflowRuleGroupsController", "x-operation-name": "count", "tags": [ "ProcessflowRuleGroupsController" ], "responses": { "200": { "description": "ProcessflowRuleGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowRuleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowRuleGroupsController.count" } }, "/processflow-rule-groups/{id}": { "put": { "x-controller-name": "ProcessflowRuleGroupsController", "x-operation-name": "replaceById", "tags": [ "ProcessflowRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowRuleGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowRuleGroups" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowRuleGroupsController.replaceById" }, "patch": { "x-controller-name": "ProcessflowRuleGroupsController", "x-operation-name": "updateById", "tags": [ "ProcessflowRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowRuleGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowRuleGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowRuleGroupsController.updateById" }, "get": { "x-controller-name": "ProcessflowRuleGroupsController", "x-operation-name": "findById", "tags": [ "ProcessflowRuleGroupsController" ], "responses": { "200": { "description": "ProcessflowRuleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowRuleGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowRuleGroups.Filter" } } } } ], "operationId": "ProcessflowRuleGroupsController.findById" }, "delete": { "x-controller-name": "ProcessflowRuleGroupsController", "x-operation-name": "deleteById", "tags": [ "ProcessflowRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowRuleGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProcessflowRuleGroupsController.deleteById" } }, "/processflow-rule-groups": { "post": { "x-controller-name": "ProcessflowRuleGroupsController", "x-operation-name": "create", "tags": [ "ProcessflowRuleGroupsController" ], "responses": { "200": { "description": "ProcessflowRuleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowRuleGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessflowRuleGroups" } } } }, "operationId": "ProcessflowRuleGroupsController.create" }, "patch": { "x-controller-name": "ProcessflowRuleGroupsController", "x-operation-name": "updateAll", "tags": [ "ProcessflowRuleGroupsController" ], "responses": { "200": { "description": "ProcessflowRuleGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowRuleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowRuleGroupsPartial" } } } }, "operationId": "ProcessflowRuleGroupsController.updateAll" }, "get": { "x-controller-name": "ProcessflowRuleGroupsController", "x-operation-name": "find", "tags": [ "ProcessflowRuleGroupsController" ], "responses": { "200": { "description": "Array of ProcessflowRuleGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessflowRuleGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowRuleGroups.Filter1" } } } } ], "operationId": "ProcessflowRuleGroupsController.find" } }, "/processflow-stage-rule-groups/count": { "get": { "x-controller-name": "ProcessflowStageRuleGroupsController", "x-operation-name": "count", "tags": [ "ProcessflowStageRuleGroupsController" ], "responses": { "200": { "description": "ProcessflowStageRuleGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowStageRuleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowStageRuleGroupsController.count" } }, "/processflow-stage-rule-groups/{id}": { "put": { "x-controller-name": "ProcessflowStageRuleGroupsController", "x-operation-name": "replaceById", "tags": [ "ProcessflowStageRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowStageRuleGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStageRuleGroups" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowStageRuleGroupsController.replaceById" }, "patch": { "x-controller-name": "ProcessflowStageRuleGroupsController", "x-operation-name": "updateById", "tags": [ "ProcessflowStageRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowStageRuleGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStageRuleGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowStageRuleGroupsController.updateById" }, "get": { "x-controller-name": "ProcessflowStageRuleGroupsController", "x-operation-name": "findById", "tags": [ "ProcessflowStageRuleGroupsController" ], "responses": { "200": { "description": "ProcessflowStageRuleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStageRuleGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStageRuleGroups.Filter" } } } } ], "operationId": "ProcessflowStageRuleGroupsController.findById" }, "delete": { "x-controller-name": "ProcessflowStageRuleGroupsController", "x-operation-name": "deleteById", "tags": [ "ProcessflowStageRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowStageRuleGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProcessflowStageRuleGroupsController.deleteById" } }, "/processflow-stage-rule-groups": { "post": { "x-controller-name": "ProcessflowStageRuleGroupsController", "x-operation-name": "create", "tags": [ "ProcessflowStageRuleGroupsController" ], "responses": { "200": { "description": "ProcessflowStageRuleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStageRuleGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessflowStageRuleGroups" } } } }, "operationId": "ProcessflowStageRuleGroupsController.create" }, "patch": { "x-controller-name": "ProcessflowStageRuleGroupsController", "x-operation-name": "updateAll", "tags": [ "ProcessflowStageRuleGroupsController" ], "responses": { "200": { "description": "ProcessflowStageRuleGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowStageRuleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStageRuleGroupsPartial" } } } }, "operationId": "ProcessflowStageRuleGroupsController.updateAll" }, "get": { "x-controller-name": "ProcessflowStageRuleGroupsController", "x-operation-name": "find", "tags": [ "ProcessflowStageRuleGroupsController" ], "responses": { "200": { "description": "Array of ProcessflowStageRuleGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessflowStageRuleGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStageRuleGroups.Filter1" } } } } ], "operationId": "ProcessflowStageRuleGroupsController.find" } }, "/processflow-stages/count": { "get": { "x-controller-name": "ProcessflowStagesController", "x-operation-name": "count", "tags": [ "ProcessflowStagesController" ], "responses": { "200": { "description": "ProcessflowStages model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowStages.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowStagesController.count" } }, "/processflow-stages/{id}/business-rule-groups": { "post": { "x-controller-name": "ProcessflowStagesBusinessRuleGroupController", "x-operation-name": "create", "tags": [ "ProcessflowStagesBusinessRuleGroupController" ], "responses": { "200": { "description": "create a BusinessRuleGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroup" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBusinessRuleGroupInProcessflowStages" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowStagesBusinessRuleGroupController.create" }, "patch": { "x-controller-name": "ProcessflowStagesBusinessRuleGroupController", "x-operation-name": "patch", "tags": [ "ProcessflowStagesBusinessRuleGroupController" ], "responses": { "200": { "description": "ProcessflowStages.BusinessRuleGroup PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowStagesBusinessRuleGroupController.patch" }, "get": { "x-controller-name": "ProcessflowStagesBusinessRuleGroupController", "x-operation-name": "find", "tags": [ "ProcessflowStagesBusinessRuleGroupController" ], "responses": { "200": { "description": "Array of ProcessflowStages has many BusinessRuleGroup through StageRuleGroups", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRuleGroup" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ProcessflowStagesBusinessRuleGroupController.find" }, "delete": { "x-controller-name": "ProcessflowStagesBusinessRuleGroupController", "x-operation-name": "delete", "tags": [ "ProcessflowStagesBusinessRuleGroupController" ], "responses": { "200": { "description": "ProcessflowStages.BusinessRuleGroup DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowStagesBusinessRuleGroupController.delete" } }, "/processflow-stages/{id}": { "put": { "x-controller-name": "ProcessflowStagesController", "x-operation-name": "replaceById", "tags": [ "ProcessflowStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowStages PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStages" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowStagesController.replaceById" }, "patch": { "x-controller-name": "ProcessflowStagesController", "x-operation-name": "updateById", "tags": [ "ProcessflowStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowStages PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStagesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowStagesController.updateById" }, "get": { "x-controller-name": "ProcessflowStagesController", "x-operation-name": "findById", "tags": [ "ProcessflowStagesController" ], "responses": { "200": { "description": "ProcessflowStages model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStagesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStages.Filter" } } } } ], "operationId": "ProcessflowStagesController.findById" }, "delete": { "x-controller-name": "ProcessflowStagesController", "x-operation-name": "deleteById", "tags": [ "ProcessflowStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowStages DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProcessflowStagesController.deleteById" } }, "/processflow-stages": { "post": { "x-controller-name": "ProcessflowStagesController", "x-operation-name": "create", "tags": [ "ProcessflowStagesController" ], "responses": { "200": { "description": "ProcessflowStages model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStages" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessflowStages" } } } }, "operationId": "ProcessflowStagesController.create" }, "patch": { "x-controller-name": "ProcessflowStagesController", "x-operation-name": "updateAll", "tags": [ "ProcessflowStagesController" ], "responses": { "200": { "description": "ProcessflowStages PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowStages.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStagesPartial" } } } }, "operationId": "ProcessflowStagesController.updateAll" }, "get": { "x-controller-name": "ProcessflowStagesController", "x-operation-name": "find", "tags": [ "ProcessflowStagesController" ], "responses": { "200": { "description": "Array of ProcessflowStages model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessflowStagesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowStages.Filter1" } } } } ], "operationId": "ProcessflowStagesController.find" }, "delete": { "x-controller-name": "ProcessflowStagesController", "x-operation-name": "deleteWhere", "tags": [ "ProcessflowStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowStages DELETE success" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowStages.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowStagesController.deleteWhere" } }, "/processflows/count": { "get": { "x-controller-name": "ProcessflowController", "x-operation-name": "count", "tags": [ "ProcessflowController" ], "responses": { "200": { "description": "Processflow model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Processflow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowController.count" } }, "/processflows/{id}/business-rule-groups": { "post": { "x-controller-name": "ProcessflowBusinessRuleGroupController", "x-operation-name": "create", "tags": [ "ProcessflowBusinessRuleGroupController" ], "responses": { "200": { "description": "create a BusinessRuleGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroup" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBusinessRuleGroupInProcessflow" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowBusinessRuleGroupController.create" }, "patch": { "x-controller-name": "ProcessflowBusinessRuleGroupController", "x-operation-name": "patch", "tags": [ "ProcessflowBusinessRuleGroupController" ], "responses": { "200": { "description": "Processflow.BusinessRuleGroup PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRuleGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowBusinessRuleGroupController.patch" }, "get": { "x-controller-name": "ProcessflowBusinessRuleGroupController", "x-operation-name": "find", "tags": [ "ProcessflowBusinessRuleGroupController" ], "responses": { "200": { "description": "Array of Processflow has many BusinessRuleGroup through ProcessflowRuleGroups", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRuleGroup" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ProcessflowBusinessRuleGroupController.find" }, "delete": { "x-controller-name": "ProcessflowBusinessRuleGroupController", "x-operation-name": "delete", "tags": [ "ProcessflowBusinessRuleGroupController" ], "responses": { "200": { "description": "Processflow.BusinessRuleGroup DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BusinessRuleGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowBusinessRuleGroupController.delete" } }, "/processflows/{id}": { "put": { "x-controller-name": "ProcessflowController", "x-operation-name": "replaceById", "tags": [ "ProcessflowController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Processflow PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Processflow" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowController.replaceById" }, "patch": { "x-controller-name": "ProcessflowController", "x-operation-name": "updateById", "tags": [ "ProcessflowController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Processflow PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProcessflowController.updateById" }, "get": { "x-controller-name": "ProcessflowController", "x-operation-name": "findById", "tags": [ "ProcessflowController" ], "responses": { "200": { "description": "Processflow model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Processflow.Filter" } } } } ], "operationId": "ProcessflowController.findById" }, "delete": { "x-controller-name": "ProcessflowController", "x-operation-name": "deleteById", "tags": [ "ProcessflowController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Processflow DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProcessflowController.deleteById" } }, "/processflows": { "post": { "x-controller-name": "ProcessflowController", "x-operation-name": "create", "tags": [ "ProcessflowController" ], "responses": { "200": { "description": "Processflow model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Processflow" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessflow" } } } }, "operationId": "ProcessflowController.create" }, "patch": { "x-controller-name": "ProcessflowController", "x-operation-name": "updateAll", "tags": [ "ProcessflowController" ], "responses": { "200": { "description": "Processflow PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Processflow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowPartial" } } } }, "operationId": "ProcessflowController.updateAll" }, "get": { "x-controller-name": "ProcessflowController", "x-operation-name": "find", "tags": [ "ProcessflowController" ], "responses": { "200": { "description": "Array of Processflow model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessflowWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Processflow.Filter1" } } } } ], "operationId": "ProcessflowController.find" }, "delete": { "x-controller-name": "ProcessflowController", "x-operation-name": "deleteWhere", "tags": [ "ProcessflowController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Processflow DELETE success" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Processflow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProcessflowController.deleteWhere" } }, "/products/count": { "get": { "x-controller-name": "ProductsController", "x-operation-name": "count", "tags": [ "ProductsController" ], "responses": { "200": { "description": "Products model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Products.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProductsController.count" } }, "/products/{id}": { "put": { "x-controller-name": "ProductsController", "x-operation-name": "replaceById", "tags": [ "ProductsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Products PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Products" } } }, "x-parameter-index": 1 }, "operationId": "ProductsController.replaceById" }, "patch": { "x-controller-name": "ProductsController", "x-operation-name": "updateById", "tags": [ "ProductsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Products PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductsPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProductsController.updateById" }, "get": { "x-controller-name": "ProductsController", "x-operation-name": "findById", "tags": [ "ProductsController" ], "responses": { "200": { "description": "Products model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Products.Filter" } } } } ], "operationId": "ProductsController.findById" }, "delete": { "x-controller-name": "ProductsController", "x-operation-name": "deleteById", "tags": [ "ProductsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Products DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProductsController.deleteById" } }, "/products": { "post": { "x-controller-name": "ProductsController", "x-operation-name": "create", "tags": [ "ProductsController" ], "responses": { "200": { "description": "Products model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Products" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProducts" } } } }, "operationId": "ProductsController.create" }, "patch": { "x-controller-name": "ProductsController", "x-operation-name": "updateAll", "tags": [ "ProductsController" ], "responses": { "200": { "description": "Products PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Products.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductsPartial" } } } }, "operationId": "ProductsController.updateAll" }, "get": { "x-controller-name": "ProductsController", "x-operation-name": "find", "tags": [ "ProductsController" ], "responses": { "200": { "description": "Array of Products model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Products.Filter1" } } } } ], "operationId": "ProductsController.find" } }, "/prospect-imports/commit": { "post": { "x-controller-name": "ProspectsController", "x-operation-name": "commit", "tags": [ "ProspectsController" ], "responses": { "200": { "description": "Import report: imported / updated / skippedInvalid / skippedDuplicate", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitProspectImport" } } } }, "operationId": "ProspectsController.commit" } }, "/prospect-imports/parse": { "post": { "x-controller-name": "ProspectsController", "x-operation-name": "parse", "tags": [ "ProspectsController" ], "responses": { "200": { "description": "Detected headers, sample rows and a suggested column mapping", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParseProspectImport" } } } }, "operationId": "ProspectsController.parse" } }, "/prospective-leads/invite": { "post": { "x-controller-name": "ProspectiveLeadsController", "x-operation-name": "invite", "tags": [ "ProspectiveLeadsController" ], "responses": { "200": { "description": "Create a prospective lead invite and send invite email", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "inviteType", "firstName", "lastName", "companyName", "phone", "email", "site" ], "properties": { "inviteType": { "type": "string", "enum": [ "company", "affiliate", "subAffiliate" ] }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "companyName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "site": { "type": "string" }, "invitedByCompanyId": { "type": "number" } } } } } }, "operationId": "ProspectiveLeadsController.invite" } }, "/prospective-leads/my/debug": { "get": { "x-controller-name": "ProspectiveLeadsController", "x-operation-name": "debugMyLeads", "tags": [ "ProspectiveLeadsController" ], "responses": { "200": { "description": "Debug scoped prospective leads visibility", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "inviteType", "in": "query", "schema": { "type": "string" } } ], "operationId": "ProspectiveLeadsController.debugMyLeads" } }, "/prospective-leads/my": { "get": { "x-controller-name": "ProspectiveLeadsController", "x-operation-name": "listMyLeads", "tags": [ "ProspectiveLeadsController" ], "responses": { "200": { "description": "List prospective leads invited by current user", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "inviteType", "in": "query", "schema": { "type": "string" } }, { "name": "debug", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "ProspectiveLeadsController.listMyLeads" } }, "/prospective-leads/token/{token}/complete": { "post": { "x-controller-name": "ProspectiveLeadsController", "x-operation-name": "complete", "tags": [ "ProspectiveLeadsController" ], "responses": { "200": { "description": "Complete invited lead signup", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "firstName", "lastName", "companyName", "phone", "email", "username", "password", "passwordConfirmation" ], "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "companyName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "passwordConfirmation": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "ProspectiveLeadsController.complete" } }, "/prospective-leads/token/{token}": { "get": { "x-controller-name": "ProspectiveLeadsController", "x-operation-name": "getByToken", "tags": [ "ProspectiveLeadsController" ], "responses": { "200": { "description": "Get prospective lead by token", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProspectiveLeadsController.getByToken" } }, "/prospective-leads/{id}/resend": { "post": { "x-controller-name": "ProspectiveLeadsController", "x-operation-name": "resendInvite", "tags": [ "ProspectiveLeadsController" ], "responses": { "200": { "description": "Resend pending prospective lead invite email", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProspectiveLeadsController.resendInvite" } }, "/prospective-leads": { "get": { "x-controller-name": "ProspectiveLeadsController", "x-operation-name": "listMyLeadsAlias", "tags": [ "ProspectiveLeadsController" ], "responses": { "200": { "description": "List prospective leads invited by current user", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "inviteType", "in": "query", "schema": { "type": "string" } }, { "name": "debug", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "ProspectiveLeadsController.listMyLeadsAlias" } }, "/prospects/count": { "get": { "x-controller-name": "ProspectsController", "x-operation-name": "count", "tags": [ "ProspectsController" ], "responses": { "200": { "description": "Prospect count, scoped like /prospects", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Prospect.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProspectsController.count" } }, "/prospects/{id}/convert": { "post": { "x-controller-name": "ProspectsController", "x-operation-name": "convert", "tags": [ "ProspectsController" ], "responses": { "200": { "description": "Prospect promoted to a Lead company (the acting user is the convertedBy)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProspectsController.convert" } }, "/prospects/{id}/events": { "get": { "x-controller-name": "CampaignsController", "x-operation-name": "prospectEvents", "tags": [ "CampaignsController" ], "responses": { "200": { "description": "One prospect's timeline of campaign events, newest first", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CampaignsController.prospectEvents" } }, "/prospects": { "get": { "x-controller-name": "ProspectsController", "x-operation-name": "find", "tags": [ "ProspectsController" ], "responses": { "200": { "description": "Prospects visible to the caller (scoped to their companies)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Prospect" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Prospect.Filter" } } } } ], "operationId": "ProspectsController.find" } }, "/pt/c/{token}": { "get": { "x-controller-name": "CampaignTrackingController", "x-operation-name": "click", "tags": [ "CampaignTrackingController" ], "responses": { "200": { "description": "Return value of CampaignTrackingController.click" } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CampaignTrackingController.click" } }, "/pt/o/{token}.gif": { "get": { "x-controller-name": "CampaignTrackingController", "x-operation-name": "open", "tags": [ "CampaignTrackingController" ], "responses": { "200": { "description": "Return value of CampaignTrackingController.open" } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CampaignTrackingController.open" } }, "/pt/u/{token}": { "get": { "x-controller-name": "CampaignTrackingController", "x-operation-name": "unsubscribe", "tags": [ "CampaignTrackingController" ], "responses": { "200": { "description": "Return value of CampaignTrackingController.unsubscribe" } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CampaignTrackingController.unsubscribe" } }, "/qualification-for-revenue-reduction": { "post": { "x-controller-name": "QualificationForRevenueReductionController", "x-operation-name": "calculate", "tags": [ "QualificationForRevenueReductionController" ], "responses": { "200": { "description": "Qualification for revenue reduction", "content": { "application/json": { "schema": { "businessStartDateString": { "type": "string" }, "Q1_2019": { "type": "number" }, "Q2_2019": { "type": "number" }, "Q3_2019": { "type": "number" }, "Q4_2019": { "type": "number" }, "Q1_2020": { "type": "number" }, "Q2_2020": { "type": "number" }, "Q3_2020": { "type": "number" }, "Q4_2020": { "type": "number" }, "Q1_2021": { "type": "number" }, "Q2_2021": { "type": "number" }, "Q3_2021": { "type": "number" }, "Q4_2021": { "type": "number" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "businessStartDateString": { "type": "string" }, "Q1_2019": { "type": "number" }, "Q2_2019": { "type": "number" }, "Q3_2019": { "type": "number" }, "Q4_2019": { "type": "number" }, "Q1_2020": { "type": "number" }, "Q2_2020": { "type": "number" }, "Q3_2020": { "type": "number" }, "Q4_2020": { "type": "number" }, "Q1_2021": { "type": "number" }, "Q2_2021": { "type": "number" }, "Q3_2021": { "type": "number" }, "Q4_2021": { "type": "number" } } } } } }, "operationId": "QualificationForRevenueReductionController.calculate" } }, "/qualification-for-revenue-reduction-aggregate": { "post": { "x-controller-name": "QualificationForRevenueReductionController", "x-operation-name": "calculateAggregate", "tags": [ "QualificationForRevenueReductionController" ], "responses": { "200": { "description": "Qualification for revenue reduction with aggregate companies", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "companyGroup": { "type": "number" } } } } } }, "operationId": "QualificationForRevenueReductionController.calculateAggregate" } }, "/questions-for-jason/{id}": { "patch": { "x-controller-name": "QuestionsForJasonController", "x-operation-name": "updateById", "tags": [ "QuestionsForJasonController" ], "responses": { "200": { "description": "Update a question for Jason (edit text/tag or toggle answered)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionForJason" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateQuestionForJason" } } }, "x-parameter-index": 1 }, "operationId": "QuestionsForJasonController.updateById" }, "delete": { "x-controller-name": "QuestionsForJasonController", "x-operation-name": "deleteById", "tags": [ "QuestionsForJasonController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete a question for Jason" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "QuestionsForJasonController.deleteById" } }, "/questions-for-jason": { "post": { "x-controller-name": "QuestionsForJasonController", "x-operation-name": "create", "tags": [ "QuestionsForJasonController" ], "responses": { "200": { "description": "Create a question for Jason", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionForJason" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewQuestionForJason" } } } }, "operationId": "QuestionsForJasonController.create" }, "get": { "x-controller-name": "QuestionsForJasonController", "x-operation-name": "find", "tags": [ "QuestionsForJasonController" ], "responses": { "200": { "description": "List questions for Jason", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QuestionForJason" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionForJason.Filter" } } } } ], "operationId": "QuestionsForJasonController.find" } }, "/react-email": { "post": { "x-controller-name": "ReactEmailController", "x-operation-name": "reactEmail", "tags": [ "ReactEmailController" ], "responses": { "200": { "description": "Return value of ReactEmailController.reactEmail" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "site" ], "properties": { "type": { "type": "number" }, "site": { "type": "string" }, "to": { "type": "string" }, "userId": { "type": "string" }, "inviteeFirstName": { "type": "string" }, "inviterCompanyName": { "type": "string" }, "getStartedUrl": { "type": "string" }, "companyId": { "type": "number" } } } } }, "description": "Required input for sending emails", "required": true }, "operationId": "ReactEmailController.reactEmail" } }, "/referrer/{id}": { "delete": { "x-controller-name": "ReferrerController", "x-operation-name": "deleteById", "tags": [ "ReferrerController" ], "responses": { "204": { "description": "Referrer DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ReferrerController.deleteById" } }, "/referrer-rates/{payeeUserId}/impact": { "get": { "x-controller-name": "RatePropagationController", "x-operation-name": "rateImpact", "tags": [ "RatePropagationController" ], "responses": { "200": { "description": "Customers a per-life rate change would affect, one row per (company, slot)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "payeeUserId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "newAmount", "in": "query", "schema": { "type": "number" } } ], "operationId": "RatePropagationController.rateImpact" } }, "/referrer-rates/{payeeUserId}/propagate": { "post": { "x-controller-name": "RatePropagationController", "x-operation-name": "propagateRate", "tags": [ "RatePropagationController" ], "responses": { "200": { "description": "Apply the new per-life rate to the confirmed existing customers", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "payeeUserId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "newAmount", "targets" ], "properties": { "newAmount": { "type": "number", "minimum": 0 }, "targets": { "type": "array", "items": { "type": "object", "required": [ "companyId", "amountField" ], "properties": { "companyId": { "type": "number" }, "amountField": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "RatePropagationController.propagateRate" } }, "/referrers/count": { "get": { "x-controller-name": "ReferrerController", "x-operation-name": "count", "tags": [ "ReferrerController" ], "responses": { "200": { "description": "Referrer model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Referrer.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ReferrerController.count" } }, "/referrers/users-for-my-customers": { "get": { "x-controller-name": "ReferrerController", "x-operation-name": "findReferrerUsersForMyCustomers", "tags": [ "ReferrerController" ], "responses": { "200": { "description": "Referrer users derived from the referrer1Id…referrer6Id slots on the customers the requesting user can access", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarshalledUser" } } } } } }, "operationId": "ReferrerController.findReferrerUsersForMyCustomers" } }, "/referrers/{id}": { "put": { "x-controller-name": "ReferrerController", "x-operation-name": "replaceById", "tags": [ "ReferrerController" ], "responses": { "204": { "description": "Referrer PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referrer" } } }, "x-parameter-index": 1 }, "operationId": "ReferrerController.replaceById" }, "patch": { "x-controller-name": "ReferrerController", "x-operation-name": "updateById", "tags": [ "ReferrerController" ], "responses": { "204": { "description": "Referrer PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferrerPartial" } } }, "x-parameter-index": 1 }, "operationId": "ReferrerController.updateById" }, "get": { "x-controller-name": "ReferrerController", "x-operation-name": "findById", "tags": [ "ReferrerController" ], "responses": { "200": { "description": "Referrer model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferrerWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referrer.Filter" } } } } ], "operationId": "ReferrerController.findById" } }, "/referrers": { "post": { "x-controller-name": "ReferrerController", "x-operation-name": "create", "tags": [ "ReferrerController" ], "responses": { "200": { "description": "Referrer model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referrer" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewReferrer" } } } }, "operationId": "ReferrerController.create" }, "get": { "x-controller-name": "ReferrerController", "x-operation-name": "find", "tags": [ "ReferrerController" ], "responses": { "200": { "description": "Array of Referrer model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReferrerWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referrer.Filter1" } } } } ], "operationId": "ReferrerController.find" } }, "/refresh": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "refresh", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Token", "content": { "application/json": { "schema": { "type": "object", "properties": { "accessToken": { "type": "object" }, "roles": { "type": "array", "items": { "type": "object" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "refreshToken" ], "properties": { "refreshToken": { "type": "string" } } } } }, "description": "Reissuing Acess Token", "required": true }, "operationId": "ClearErcUsersController.refresh" } }, "/repair-stage-categories/count": { "get": { "x-controller-name": "RepairStageCategoriesController", "x-operation-name": "count", "tags": [ "RepairStageCategoriesController" ], "responses": { "200": { "description": "RepairStageCategories model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RepairStageCategories.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RepairStageCategoriesController.count" } }, "/repair-stage-categories/{id}": { "put": { "x-controller-name": "RepairStageCategoriesController", "x-operation-name": "replaceById", "tags": [ "RepairStageCategoriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RepairStageCategories PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageCategories" } } }, "x-parameter-index": 1 }, "operationId": "RepairStageCategoriesController.replaceById" }, "patch": { "x-controller-name": "RepairStageCategoriesController", "x-operation-name": "updateById", "tags": [ "RepairStageCategoriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RepairStageCategories PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageCategoriesPartial" } } }, "x-parameter-index": 1 }, "operationId": "RepairStageCategoriesController.updateById" }, "get": { "x-controller-name": "RepairStageCategoriesController", "x-operation-name": "findById", "tags": [ "RepairStageCategoriesController" ], "responses": { "200": { "description": "RepairStageCategories model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageCategoriesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageCategories.Filter" } } } } ], "operationId": "RepairStageCategoriesController.findById" }, "delete": { "x-controller-name": "RepairStageCategoriesController", "x-operation-name": "deleteById", "tags": [ "RepairStageCategoriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RepairStageCategories DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RepairStageCategoriesController.deleteById" } }, "/repair-stage-categories": { "post": { "x-controller-name": "RepairStageCategoriesController", "x-operation-name": "create", "tags": [ "RepairStageCategoriesController" ], "responses": { "200": { "description": "RepairStageCategories model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageCategories" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRepairStageCategories" } } } }, "operationId": "RepairStageCategoriesController.create" }, "patch": { "x-controller-name": "RepairStageCategoriesController", "x-operation-name": "updateAll", "tags": [ "RepairStageCategoriesController" ], "responses": { "200": { "description": "RepairStageCategories PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RepairStageCategories.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageCategoriesPartial" } } } }, "operationId": "RepairStageCategoriesController.updateAll" }, "get": { "x-controller-name": "RepairStageCategoriesController", "x-operation-name": "find", "tags": [ "RepairStageCategoriesController" ], "responses": { "200": { "description": "Array of RepairStageCategories model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepairStageCategoriesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageCategories.Filter1" } } } } ], "operationId": "RepairStageCategoriesController.find" } }, "/repair-stage-histories/count": { "get": { "x-controller-name": "RepairStageHistoriesController", "x-operation-name": "count", "tags": [ "RepairStageHistoriesController" ], "responses": { "200": { "description": "RepairStageHistory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RepairStageHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RepairStageHistoriesController.count" } }, "/repair-stage-histories/{id}": { "put": { "x-controller-name": "RepairStageHistoriesController", "x-operation-name": "replaceById", "tags": [ "RepairStageHistoriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RepairStageHistory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageHistory" } } }, "x-parameter-index": 1 }, "operationId": "RepairStageHistoriesController.replaceById" }, "patch": { "x-controller-name": "RepairStageHistoriesController", "x-operation-name": "updateById", "tags": [ "RepairStageHistoriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RepairStageHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageHistoryPartial" } } }, "x-parameter-index": 1 }, "operationId": "RepairStageHistoriesController.updateById" }, "get": { "x-controller-name": "RepairStageHistoriesController", "x-operation-name": "findById", "tags": [ "RepairStageHistoriesController" ], "responses": { "200": { "description": "RepairStageHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageHistoryWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageHistory.Filter" } } } } ], "operationId": "RepairStageHistoriesController.findById" }, "delete": { "x-controller-name": "RepairStageHistoriesController", "x-operation-name": "deleteById", "tags": [ "RepairStageHistoriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RepairStageHistory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RepairStageHistoriesController.deleteById" } }, "/repair-stage-histories": { "post": { "x-controller-name": "RepairStageHistoriesController", "x-operation-name": "create", "tags": [ "RepairStageHistoriesController" ], "responses": { "200": { "description": "RepairStageHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRepairStageHistory" } } } }, "operationId": "RepairStageHistoriesController.create" }, "patch": { "x-controller-name": "RepairStageHistoriesController", "x-operation-name": "updateAll", "tags": [ "RepairStageHistoriesController" ], "responses": { "200": { "description": "RepairStageHistory PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RepairStageHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageHistoryPartial" } } } }, "operationId": "RepairStageHistoriesController.updateAll" }, "get": { "x-controller-name": "RepairStageHistoriesController", "x-operation-name": "find", "tags": [ "RepairStageHistoriesController" ], "responses": { "200": { "description": "Array of RepairStageHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepairStageHistoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageHistory.Filter1" } } } } ], "operationId": "RepairStageHistoriesController.find" } }, "/repair-stage-histories-alert": { "get": { "x-controller-name": "RepairStageHistoriesController", "x-operation-name": "alert", "tags": [ "RepairStageHistoriesController" ], "responses": { "200": { "description": "RepairStageHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStageHistoryWithRelations" } } } } }, "operationId": "RepairStageHistoriesController.alert" } }, "/repair-stages/count": { "get": { "x-controller-name": "RepairStagesController", "x-operation-name": "count", "tags": [ "RepairStagesController" ], "responses": { "200": { "description": "RepairStages model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RepairStages.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RepairStagesController.count" } }, "/repair-stages/{id}": { "put": { "x-controller-name": "RepairStagesController", "x-operation-name": "replaceById", "tags": [ "RepairStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RepairStages PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStages" } } }, "x-parameter-index": 1 }, "operationId": "RepairStagesController.replaceById" }, "patch": { "x-controller-name": "RepairStagesController", "x-operation-name": "updateById", "tags": [ "RepairStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RepairStages PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStagesPartial" } } }, "x-parameter-index": 1 }, "operationId": "RepairStagesController.updateById" }, "get": { "x-controller-name": "RepairStagesController", "x-operation-name": "findById", "tags": [ "RepairStagesController" ], "responses": { "200": { "description": "RepairStages model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStagesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStages.Filter" } } } } ], "operationId": "RepairStagesController.findById" }, "delete": { "x-controller-name": "RepairStagesController", "x-operation-name": "deleteById", "tags": [ "RepairStagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RepairStages DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RepairStagesController.deleteById" } }, "/repair-stages": { "post": { "x-controller-name": "RepairStagesController", "x-operation-name": "create", "tags": [ "RepairStagesController" ], "responses": { "200": { "description": "RepairStages model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStages" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRepairStages" } } } }, "operationId": "RepairStagesController.create" }, "patch": { "x-controller-name": "RepairStagesController", "x-operation-name": "updateAll", "tags": [ "RepairStagesController" ], "responses": { "200": { "description": "RepairStages PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RepairStages.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStagesPartial" } } } }, "operationId": "RepairStagesController.updateAll" }, "get": { "x-controller-name": "RepairStagesController", "x-operation-name": "find", "tags": [ "RepairStagesController" ], "responses": { "200": { "description": "Array of RepairStages model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepairStagesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairStages.Filter1" } } } } ], "operationId": "RepairStagesController.find" } }, "/reward-activity-types/{id}": { "patch": { "x-controller-name": "RewardActivityTypeController", "x-operation-name": "updateById", "tags": [ "RewardActivityTypeController" ], "responses": { "200": { "description": "The updated reward activity type row", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RewardActivityType" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 128 }, "level": { "type": "string", "nullable": true, "maxLength": 32 }, "groupSlug": { "type": "string", "nullable": true, "maxLength": 64 }, "cptCode": { "type": "string", "nullable": true, "maxLength": 16 }, "frequencyCap": { "type": "number", "nullable": true }, "frequencyPeriod": { "type": "string" }, "documentationRequired": { "type": "boolean" }, "active": { "type": "boolean" }, "effectiveTo": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "RewardActivityTypeController.updateById" } }, "/reward-activity-types": { "post": { "x-controller-name": "RewardActivityTypeController", "x-operation-name": "create", "tags": [ "RewardActivityTypeController" ], "responses": { "200": { "description": "The created reward activity type row", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RewardActivityType" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "maxLength": 64 }, "name": { "type": "string", "maxLength": 128 }, "level": { "type": "string", "nullable": true, "maxLength": 32 }, "groupSlug": { "type": "string", "nullable": true, "maxLength": 64 }, "cptCode": { "type": "string", "nullable": true, "maxLength": 16 }, "valueCents": { "type": "number", "nullable": true }, "frequencyCap": { "type": "number", "nullable": true }, "frequencyPeriod": { "type": "string" }, "documentationRequired": { "type": "boolean" }, "active": { "type": "boolean" }, "effectiveFrom": { "type": "string" }, "effectiveTo": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } } } } } }, "operationId": "RewardActivityTypeController.create" }, "get": { "x-controller-name": "RewardActivityTypeController", "x-operation-name": "find", "tags": [ "RewardActivityTypeController" ], "responses": { "200": { "description": "Reward activity type rows (all pricing windows)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RewardActivityType" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RewardActivityType.Filter" } } } } ], "operationId": "RewardActivityTypeController.find" } }, "/role-group-entries/count": { "get": { "x-controller-name": "RoleGroupEntriesController", "x-operation-name": "count", "tags": [ "RoleGroupEntriesController" ], "responses": { "200": { "description": "RoleGroupEntries model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleGroupEntries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RoleGroupEntriesController.count" } }, "/role-group-entries/{id}": { "put": { "x-controller-name": "RoleGroupEntriesController", "x-operation-name": "replaceById", "tags": [ "RoleGroupEntriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleGroupEntries PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupEntries" } } }, "x-parameter-index": 1 }, "operationId": "RoleGroupEntriesController.replaceById" }, "patch": { "x-controller-name": "RoleGroupEntriesController", "x-operation-name": "updateById", "tags": [ "RoleGroupEntriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleGroupEntries PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupEntriesPartial" } } }, "x-parameter-index": 1 }, "operationId": "RoleGroupEntriesController.updateById" }, "get": { "x-controller-name": "RoleGroupEntriesController", "x-operation-name": "findById", "tags": [ "RoleGroupEntriesController" ], "responses": { "200": { "description": "RoleGroupEntries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupEntriesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupEntries.Filter" } } } } ], "operationId": "RoleGroupEntriesController.findById" }, "delete": { "x-controller-name": "RoleGroupEntriesController", "x-operation-name": "deleteById", "tags": [ "RoleGroupEntriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleGroupEntries DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RoleGroupEntriesController.deleteById" } }, "/role-group-entries": { "post": { "x-controller-name": "RoleGroupEntriesController", "x-operation-name": "create", "tags": [ "RoleGroupEntriesController" ], "responses": { "200": { "description": "RoleGroupEntries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupEntries" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRoleGroupEntries" } } } }, "operationId": "RoleGroupEntriesController.create" }, "patch": { "x-controller-name": "RoleGroupEntriesController", "x-operation-name": "updateAll", "tags": [ "RoleGroupEntriesController" ], "responses": { "200": { "description": "RoleGroupEntries PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleGroupEntries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupEntriesPartial" } } } }, "operationId": "RoleGroupEntriesController.updateAll" }, "get": { "x-controller-name": "RoleGroupEntriesController", "x-operation-name": "find", "tags": [ "RoleGroupEntriesController" ], "responses": { "200": { "description": "Array of RoleGroupEntries model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleGroupEntriesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupEntries.Filter1" } } } } ], "operationId": "RoleGroupEntriesController.find" }, "delete": { "x-controller-name": "RoleGroupEntriesController", "x-operation-name": "deleteWhere", "tags": [ "RoleGroupEntriesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProcessflowStages DELETE success" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleGroupEntries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RoleGroupEntriesController.deleteWhere" } }, "/role-group-users/count": { "get": { "x-controller-name": "RoleGroupUsersController", "x-operation-name": "count", "tags": [ "RoleGroupUsersController" ], "responses": { "200": { "description": "RoleGroupUsers model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleGroupUsers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RoleGroupUsersController.count" } }, "/role-group-users/{id}": { "put": { "x-controller-name": "RoleGroupUsersController", "x-operation-name": "replaceById", "tags": [ "RoleGroupUsersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleGroupUsers PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupUsers" } } }, "x-parameter-index": 1 }, "operationId": "RoleGroupUsersController.replaceById" }, "patch": { "x-controller-name": "RoleGroupUsersController", "x-operation-name": "updateById", "tags": [ "RoleGroupUsersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleGroupUsers PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupUsersPartial" } } }, "x-parameter-index": 1 }, "operationId": "RoleGroupUsersController.updateById" }, "get": { "x-controller-name": "RoleGroupUsersController", "x-operation-name": "findById", "tags": [ "RoleGroupUsersController" ], "responses": { "200": { "description": "RoleGroupUsers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupUsersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupUsers.Filter" } } } } ], "operationId": "RoleGroupUsersController.findById" }, "delete": { "x-controller-name": "RoleGroupUsersController", "x-operation-name": "deleteById", "tags": [ "RoleGroupUsersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleGroupUsers DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RoleGroupUsersController.deleteById" } }, "/role-group-users": { "post": { "x-controller-name": "RoleGroupUsersController", "x-operation-name": "create", "tags": [ "RoleGroupUsersController" ], "responses": { "200": { "description": "RoleGroupUsers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupUsers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRoleGroupUsers" } } } }, "operationId": "RoleGroupUsersController.create" }, "patch": { "x-controller-name": "RoleGroupUsersController", "x-operation-name": "updateAll", "tags": [ "RoleGroupUsersController" ], "responses": { "200": { "description": "RoleGroupUsers PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleGroupUsers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupUsersPartial" } } } }, "operationId": "RoleGroupUsersController.updateAll" }, "get": { "x-controller-name": "RoleGroupUsersController", "x-operation-name": "find", "tags": [ "RoleGroupUsersController" ], "responses": { "200": { "description": "Array of RoleGroupUsers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleGroupUsersWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupUsers.Filter1" } } } } ], "operationId": "RoleGroupUsersController.find" } }, "/role-groups/count": { "get": { "x-controller-name": "RoleGroupsController", "x-operation-name": "count", "tags": [ "RoleGroupsController" ], "responses": { "200": { "description": "RoleGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RoleGroupsController.count" } }, "/role-groups/{id}/processflow-groups": { "post": { "x-controller-name": "RoleGroupsProcessflowGroupController", "x-operation-name": "create", "tags": [ "RoleGroupsProcessflowGroupController" ], "responses": { "200": { "description": "create a ProcessflowGroup model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroup" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessflowGroupInRoleGroups" } } }, "x-parameter-index": 1 }, "operationId": "RoleGroupsProcessflowGroupController.create" }, "patch": { "x-controller-name": "RoleGroupsProcessflowGroupController", "x-operation-name": "patch", "tags": [ "RoleGroupsProcessflowGroupController" ], "responses": { "200": { "description": "RoleGroups.ProcessflowGroup PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessflowGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "RoleGroupsProcessflowGroupController.patch" }, "get": { "x-controller-name": "RoleGroupsProcessflowGroupController", "x-operation-name": "find", "tags": [ "RoleGroupsProcessflowGroupController" ], "responses": { "200": { "description": "Array of RoleGroups has many ProcessflowGroup through ProcessflowGroupRoleGroups", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessflowGroup" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "RoleGroupsProcessflowGroupController.find" }, "delete": { "x-controller-name": "RoleGroupsProcessflowGroupController", "x-operation-name": "delete", "tags": [ "RoleGroupsProcessflowGroupController" ], "responses": { "200": { "description": "RoleGroups.ProcessflowGroup DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProcessflowGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RoleGroupsProcessflowGroupController.delete" } }, "/role-groups/{id}/roles": { "post": { "x-controller-name": "RoleGroupsRolesController", "x-operation-name": "create", "tags": [ "RoleGroupsRolesController" ], "responses": { "200": { "description": "create a Roles model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRolesInRoleGroups" } } }, "x-parameter-index": 1 }, "operationId": "RoleGroupsRolesController.create" }, "patch": { "x-controller-name": "RoleGroupsRolesController", "x-operation-name": "patch", "tags": [ "RoleGroupsRolesController" ], "responses": { "200": { "description": "RoleGroups.Roles PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Roles.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesPartial" } } }, "x-parameter-index": 1 }, "operationId": "RoleGroupsRolesController.patch" }, "get": { "x-controller-name": "RoleGroupsRolesController", "x-operation-name": "find", "tags": [ "RoleGroupsRolesController" ], "responses": { "200": { "description": "Array of RoleGroups has many Roles through RoleGroupEntries", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Roles" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "RoleGroupsRolesController.find" }, "delete": { "x-controller-name": "RoleGroupsRolesController", "x-operation-name": "delete", "tags": [ "RoleGroupsRolesController" ], "responses": { "200": { "description": "RoleGroups.Roles DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Roles.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RoleGroupsRolesController.delete" } }, "/role-groups/{id}": { "put": { "x-controller-name": "RoleGroupsController", "x-operation-name": "replaceById", "tags": [ "RoleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroups" } } }, "x-parameter-index": 1 }, "operationId": "RoleGroupsController.replaceById" }, "patch": { "x-controller-name": "RoleGroupsController", "x-operation-name": "updateById", "tags": [ "RoleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "RoleGroupsController.updateById" }, "get": { "x-controller-name": "RoleGroupsController", "x-operation-name": "findById", "tags": [ "RoleGroupsController" ], "responses": { "200": { "description": "RoleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroups.Filter" } } } } ], "operationId": "RoleGroupsController.findById" }, "delete": { "x-controller-name": "RoleGroupsController", "x-operation-name": "deleteById", "tags": [ "RoleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RoleGroupsController.deleteById" } }, "/role-groups": { "post": { "x-controller-name": "RoleGroupsController", "x-operation-name": "create", "tags": [ "RoleGroupsController" ], "responses": { "200": { "description": "RoleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRoleGroups" } } } }, "operationId": "RoleGroupsController.create" }, "patch": { "x-controller-name": "RoleGroupsController", "x-operation-name": "updateAll", "tags": [ "RoleGroupsController" ], "responses": { "200": { "description": "RoleGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroupsPartial" } } } }, "operationId": "RoleGroupsController.updateAll" }, "get": { "x-controller-name": "RoleGroupsController", "x-operation-name": "find", "tags": [ "RoleGroupsController" ], "responses": { "200": { "description": "Array of RoleGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleGroups.Filter1" } } } } ], "operationId": "RoleGroupsController.find" } }, "/role-users/count": { "get": { "x-controller-name": "RoleUsersController", "x-operation-name": "count", "tags": [ "RoleUsersController" ], "responses": { "200": { "description": "RoleUsers model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleUsers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RoleUsersController.count" } }, "/role-users/{id}": { "put": { "x-controller-name": "RoleUsersController", "x-operation-name": "replaceById", "tags": [ "RoleUsersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleUsers PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUsers" } } }, "x-parameter-index": 1 }, "operationId": "RoleUsersController.replaceById" }, "patch": { "x-controller-name": "RoleUsersController", "x-operation-name": "updateById", "tags": [ "RoleUsersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleUsers PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUsersPartial" } } }, "x-parameter-index": 1 }, "operationId": "RoleUsersController.updateById" }, "get": { "x-controller-name": "RoleUsersController", "x-operation-name": "findById", "tags": [ "RoleUsersController" ], "responses": { "200": { "description": "RoleUsers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUsersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUsers.Filter" } } } } ], "operationId": "RoleUsersController.findById" }, "delete": { "x-controller-name": "RoleUsersController", "x-operation-name": "deleteById", "tags": [ "RoleUsersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RoleUsers DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RoleUsersController.deleteById" } }, "/role-users": { "post": { "x-controller-name": "RoleUsersController", "x-operation-name": "create", "tags": [ "RoleUsersController" ], "responses": { "200": { "description": "RoleUsers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUsers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRoleUsers" } } } }, "operationId": "RoleUsersController.create" }, "patch": { "x-controller-name": "RoleUsersController", "x-operation-name": "updateAll", "tags": [ "RoleUsersController" ], "responses": { "200": { "description": "RoleUsers PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RoleUsers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUsersPartial" } } } }, "operationId": "RoleUsersController.updateAll" }, "get": { "x-controller-name": "RoleUsersController", "x-operation-name": "find", "tags": [ "RoleUsersController" ], "responses": { "200": { "description": "Array of RoleUsers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleUsersWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUsers.Filter1" } } } } ], "operationId": "RoleUsersController.find" } }, "/roles/count": { "get": { "x-controller-name": "RolesController", "x-operation-name": "count", "tags": [ "RolesController" ], "responses": { "200": { "description": "Roles model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Roles.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RolesController.count" } }, "/roles/{id}": { "put": { "x-controller-name": "RolesController", "x-operation-name": "replaceById", "tags": [ "RolesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Roles PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles" } } }, "x-parameter-index": 1 }, "operationId": "RolesController.replaceById" }, "patch": { "x-controller-name": "RolesController", "x-operation-name": "updateById", "tags": [ "RolesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Roles PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesPartial" } } }, "x-parameter-index": 1 }, "operationId": "RolesController.updateById" }, "get": { "x-controller-name": "RolesController", "x-operation-name": "findById", "tags": [ "RolesController" ], "responses": { "200": { "description": "Roles model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles.Filter" } } } } ], "operationId": "RolesController.findById" }, "delete": { "x-controller-name": "RolesController", "x-operation-name": "deleteById", "tags": [ "RolesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Roles DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RolesController.deleteById" } }, "/roles": { "post": { "x-controller-name": "RolesController", "x-operation-name": "create", "tags": [ "RolesController" ], "responses": { "200": { "description": "Roles model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRoles" } } } }, "operationId": "RolesController.create" }, "patch": { "x-controller-name": "RolesController", "x-operation-name": "updateAll", "tags": [ "RolesController" ], "responses": { "200": { "description": "Roles PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Roles.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesPartial" } } } }, "operationId": "RolesController.updateAll" }, "get": { "x-controller-name": "RolesController", "x-operation-name": "find", "tags": [ "RolesController" ], "responses": { "200": { "description": "Array of Roles model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RolesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles.Filter1" } } } } ], "operationId": "RolesController.find" } }, "/routing-numbers/{routingNumber}": { "get": { "x-controller-name": "RoutingNumbersController", "x-operation-name": "lookup", "tags": [ "RoutingNumbersController" ], "responses": { "200": { "description": "The bank behind an ABA routing number; bankName/city/state are null when unknown.", "content": { "application/json": { "schema": { "type": "object", "properties": { "routingNumber": { "type": "string" }, "bankName": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true } } } } } }, "422": { "description": "Not a valid ABA routing number (9 digits + mod-10 checksum)." } }, "parameters": [ { "name": "routingNumber", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "RoutingNumbersController.lookup" } }, "/sales-material/from-document": { "post": { "x-controller-name": "SalesMaterialController", "x-operation-name": "createFromDocument", "tags": [ "SalesMaterialController" ], "responses": { "200": { "description": "Create a sales material item from an existing company document (super-user only)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesMaterial" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSalesMaterialFromDocument" } } } }, "operationId": "SalesMaterialController.createFromDocument" } }, "/sales-material/presentation-config": { "get": { "x-controller-name": "SalesMaterialController", "x-operation-name": "findPresentationConfigTemplate", "tags": [ "SalesMaterialController" ], "responses": { "200": { "description": "The measured injection map for the current deck, for prefilling a presentation row (super-user only)", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "SalesMaterialController.findPresentationConfigTemplate" } }, "/sales-material/{id}/download": { "get": { "x-controller-name": "SalesMaterialController", "x-operation-name": "download", "tags": [ "SalesMaterialController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SalesMaterialController.download" } }, "/sales-material/{id}/replace": { "post": { "x-controller-name": "SalesMaterialController", "x-operation-name": "replace", "tags": [ "SalesMaterialController" ], "responses": { "200": { "description": "Replace the PDF behind a sales material item (super-user only)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesMaterial" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "SalesMaterialController.replace" } }, "/sales-material/{id}": { "patch": { "x-controller-name": "SalesMaterialController", "x-operation-name": "updateById", "tags": [ "SalesMaterialController" ], "responses": { "200": { "description": "Update a sales material item (super-user only)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesMaterial" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSalesMaterial" } } }, "x-parameter-index": 1 }, "operationId": "SalesMaterialController.updateById" } }, "/sales-material": { "post": { "x-controller-name": "SalesMaterialController", "x-operation-name": "create", "tags": [ "SalesMaterialController" ], "responses": { "200": { "description": "Upload a new sales material PDF (super-user only)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesMaterial" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "SalesMaterialController.create" }, "get": { "x-controller-name": "SalesMaterialController", "x-operation-name": "find", "tags": [ "SalesMaterialController" ], "responses": { "200": { "description": "List sales material (active and retired), alphabetical", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesMaterial" } } } } } }, "operationId": "SalesMaterialController.find" } }, "/scheduled-emails/{id}/cancel": { "post": { "x-controller-name": "ScheduledEmailsController", "x-operation-name": "cancel", "tags": [ "ScheduledEmailsController" ], "responses": { "200": { "description": "Return value of ScheduledEmailsController.cancel" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ScheduledEmailsController.cancel" } }, "/scheduled-emails": { "get": { "x-controller-name": "ScheduledEmailsController", "x-operation-name": "list", "tags": [ "ScheduledEmailsController" ], "responses": { "200": { "description": "Return value of ScheduledEmailsController.list" } }, "operationId": "ScheduledEmailsController.list" } }, "/send-email": { "post": { "x-controller-name": "EmailController", "x-operation-name": "sendEmail", "tags": [ "EmailController" ], "responses": { "200": { "description": "DEPRECATED (#4306) — validates the payload and dispatches NOTHING. The SendGrid transport behind it is retired. Use the Resend path instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Email" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEmail" } } } }, "operationId": "EmailController.sendEmail" } }, "/send-sms": { "post": { "x-controller-name": "SMSController", "x-operation-name": "sendSms", "tags": [ "SMSController" ], "responses": { "200": { "description": "Send an SMS", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sms" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendSMS" } } } }, "operationId": "SMSController.sendSms" } }, "/set-password": { "post": { "x-controller-name": "SetPasswordController", "x-operation-name": "setPassword", "tags": [ "SetPasswordController" ], "responses": { "200": { "description": "New password", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "verificationToken": { "type": "string" }, "password": { "type": "string" } } } } } }, "operationId": "SetPasswordController.setPassword" } }, "/shared-dashboard-layouts/{scope}": { "put": { "x-controller-name": "SharedDashboardLayoutController", "x-operation-name": "upsertByScope", "tags": [ "SharedDashboardLayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Upsert the shared layout for the scope (super users only)." } } } } }, "parameters": [ { "name": "scope", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "title": "SharedDashboardLayoutSave" } } }, "x-parameter-index": 1 }, "operationId": "SharedDashboardLayoutController.upsertByScope" }, "get": { "x-controller-name": "SharedDashboardLayoutController", "x-operation-name": "findByScope", "tags": [ "SharedDashboardLayoutController" ], "responses": { "200": { "description": "The shared layout for the scope, or null when none is set.", "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string" }, "layout": { "nullable": true }, "updatedAt": { "type": "string", "nullable": true } } } } } } }, "parameters": [ { "name": "scope", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SharedDashboardLayoutController.findByScope" } }, "/signed-contracts/{id}/pdf": { "get": { "x-controller-name": "SignedContractsController", "x-operation-name": "downloadSnapshot", "tags": [ "SignedContractsController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SignedContractsController.downloadSnapshot" } }, "/signed-contracts/{id}": { "delete": { "x-controller-name": "SignedContractsController", "x-operation-name": "softDeleteById", "tags": [ "SignedContractsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Signed contract soft-deleted" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SignedContractsController.softDeleteById" } }, "/signed-contracts": { "post": { "x-controller-name": "SignedContractsController", "x-operation-name": "create", "tags": [ "SignedContractsController" ], "responses": { "200": { "description": "Signed contract record created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedContracts" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSignedContract" } } }, "required": true }, "operationId": "SignedContractsController.create" }, "get": { "x-controller-name": "SignedContractsController", "x-operation-name": "find", "tags": [ "SignedContractsController" ], "responses": { "200": { "description": "Signed contract records", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SignedContractsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedContracts.Filter" } } } } ], "operationId": "SignedContractsController.find" } }, "/sms-messages/count": { "get": { "x-controller-name": "SmsMessageController", "x-operation-name": "count", "tags": [ "SmsMessageController" ], "responses": { "200": { "description": "SmsMessage model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "SmsMessage.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "SmsMessageController.count" } }, "/sms-messages": { "get": { "x-controller-name": "SmsMessageController", "x-operation-name": "find", "tags": [ "SmsMessageController" ], "responses": { "200": { "description": "Array of SmsMessage model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmsMessage" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsMessage.Filter" } } } } ], "operationId": "SmsMessageController.find" } }, "/sms-notification": { "get": { "x-controller-name": "SMSController", "x-operation-name": "getSmsNotification", "tags": [ "SMSController" ], "responses": { "200": { "description": "Get a unique ID 5 character link for an SMS URL and return it as the uniqueUrl\n property of the notification object. This is used for the user to track the status of the SMS\n and to click on the link to view the SMS. It is also used to make sure future SMSs are not\n sent to the same phone number. The uniqueUrl is also used to make sure the SMS is not sent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIdResponse" } } } } }, "operationId": "SMSController.getSmsNotification" } }, "/staff-assistant/analytics": { "get": { "x-controller-name": "StaffAssistantController", "x-operation-name": "usageAnalytics", "tags": [ "StaffAssistantController" ], "responses": { "200": { "description": "Aggregate staff-assistant usage for a window: totals, answer/escalation rates, the most-asked topics, and the recurring topics the corpus cannot answer. Accepts ?window=7|30|90 (days, default 30). SuperUser only.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "window", "in": "query", "schema": { "type": "string" }, "description": "Window in days. One of 7, 30, 90 (default 30); anything else is a 422." } ], "operationId": "StaffAssistantController.usageAnalytics" } }, "/staff-assistant/answer-flags/{flagId}/confirm": { "post": { "x-controller-name": "StaffAssistantController", "x-operation-name": "confirmAnswerFlag", "tags": [ "StaffAssistantController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Retire the flagged stored answer" } } } } }, "parameters": [ { "name": "flagId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false, "x-parameter-index": 1 }, "operationId": "StaffAssistantController.confirmAnswerFlag" } }, "/staff-assistant/answer-flags/{flagId}/dismiss": { "post": { "x-controller-name": "StaffAssistantController", "x-operation-name": "dismissAnswerFlag", "tags": [ "StaffAssistantController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Dismiss the flag; the answer keeps serving" } } } } }, "parameters": [ { "name": "flagId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false, "x-parameter-index": 1 }, "operationId": "StaffAssistantController.dismissAnswerFlag" } }, "/staff-assistant/answer-flags": { "get": { "x-controller-name": "StaffAssistantController", "x-operation-name": "listAnswerFlags", "tags": [ "StaffAssistantController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Open answer flags awaiting an expert decision" } } } } }, "operationId": "StaffAssistantController.listAnswerFlags" } }, "/staff-assistant/ask": { "post": { "x-controller-name": "StaffAssistantController", "x-operation-name": "ask", "tags": [ "StaffAssistantController" ], "responses": { "200": { "description": "A grounded, cited answer to a staff question", "content": { "application/json": { "schema": { "type": "object", "properties": { "threadId": { "type": "number" }, "answer": { "type": "string" }, "state": { "type": "string" }, "citedSlugs": { "type": "array", "items": { "type": "string" } }, "citedTools": { "type": "array", "items": { "type": "string" } }, "grounded": { "type": "boolean" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffAssistantAskRequest" } } } }, "operationId": "StaffAssistantController.ask" } }, "/staff-assistant/messages/{messageId}/flag": { "post": { "x-controller-name": "StaffAssistantController", "x-operation-name": "flagAnswerRoute", "tags": [ "StaffAssistantController" ], "responses": { "200": { "description": "Flag an answer as wrong; re-escalates and may open an expert decision", "content": { "application/json": { "schema": { "type": "object", "properties": { "outcome": { "type": "string" }, "storedAnswerId": { "type": "number" } } } } } } }, "parameters": [ { "name": "messageId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false, "x-parameter-index": 1 }, "operationId": "StaffAssistantController.flagAnswerRoute" } }, "/staff-assistant/threads/{id}": { "get": { "x-controller-name": "StaffAssistantController", "x-operation-name": "getThread", "tags": [ "StaffAssistantController" ], "responses": { "200": { "description": "One of the caller’s own threads, with its messages in order", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "StaffAssistantController.getThread" } }, "/staff-assistant/threads": { "get": { "x-controller-name": "StaffAssistantController", "x-operation-name": "listThreads", "tags": [ "StaffAssistantController" ], "responses": { "200": { "description": "The caller’s own recent threads, newest first", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "description": "How many threads to return (default 20, max 50). Out-of-range and junk values are clamped, never rejected." } ], "operationId": "StaffAssistantController.listThreads" } }, "/stage-histories/count": { "get": { "x-controller-name": "StageHistoryController", "x-operation-name": "count", "tags": [ "StageHistoryController" ], "responses": { "200": { "description": "StageHistory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "StageHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "StageHistoryController.count" } }, "/stage-histories/{id}": { "put": { "x-controller-name": "StageHistoryController", "x-operation-name": "replaceById", "tags": [ "StageHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "StageHistory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StageHistory" } } }, "x-parameter-index": 1 }, "operationId": "StageHistoryController.replaceById" }, "patch": { "x-controller-name": "StageHistoryController", "x-operation-name": "updateById", "tags": [ "StageHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "StageHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StageHistoryPartial" } } }, "x-parameter-index": 1 }, "operationId": "StageHistoryController.updateById" }, "get": { "x-controller-name": "StageHistoryController", "x-operation-name": "findById", "tags": [ "StageHistoryController" ], "responses": { "200": { "description": "StageHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StageHistoryWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StageHistory.Filter" } } } } ], "operationId": "StageHistoryController.findById" }, "delete": { "x-controller-name": "StageHistoryController", "x-operation-name": "deleteById", "tags": [ "StageHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "StageHistory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "StageHistoryController.deleteById" } }, "/stage-histories": { "post": { "x-controller-name": "StageHistoryController", "x-operation-name": "create", "tags": [ "StageHistoryController" ], "responses": { "200": { "description": "StageHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StageHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewStageHistory" } } } }, "operationId": "StageHistoryController.create" }, "patch": { "x-controller-name": "StageHistoryController", "x-operation-name": "updateAll", "tags": [ "StageHistoryController" ], "responses": { "200": { "description": "StageHistory PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "StageHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StageHistoryPartial" } } } }, "operationId": "StageHistoryController.updateAll" }, "get": { "x-controller-name": "StageHistoryController", "x-operation-name": "find", "tags": [ "StageHistoryController" ], "responses": { "200": { "description": "Array of StageHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StageHistoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StageHistory.Filter1" } } } } ], "operationId": "StageHistoryController.find" } }, "/stages/count": { "get": { "x-controller-name": "StagesController", "x-operation-name": "count", "tags": [ "StagesController" ], "responses": { "200": { "description": "Stages model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Stages.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "StagesController.count" } }, "/stages/{id}": { "put": { "x-controller-name": "StagesController", "x-operation-name": "replaceById", "tags": [ "StagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Stages PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stages" } } }, "x-parameter-index": 1 }, "operationId": "StagesController.replaceById" }, "patch": { "x-controller-name": "StagesController", "x-operation-name": "updateById", "tags": [ "StagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Stages PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StagesPartial" } } }, "x-parameter-index": 1 }, "operationId": "StagesController.updateById" }, "get": { "x-controller-name": "StagesController", "x-operation-name": "findById", "tags": [ "StagesController" ], "responses": { "200": { "description": "Stages model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StagesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stages.Filter" } } } } ], "operationId": "StagesController.findById" }, "delete": { "x-controller-name": "StagesController", "x-operation-name": "deleteById", "tags": [ "StagesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Stages DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "StagesController.deleteById" } }, "/stages": { "post": { "x-controller-name": "StagesController", "x-operation-name": "create", "tags": [ "StagesController" ], "responses": { "200": { "description": "Stages model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stages" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewStages" } } } }, "operationId": "StagesController.create" }, "patch": { "x-controller-name": "StagesController", "x-operation-name": "updateAll", "tags": [ "StagesController" ], "responses": { "200": { "description": "Stages PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Stages.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StagesPartial" } } } }, "operationId": "StagesController.updateAll" }, "get": { "x-controller-name": "StagesController", "x-operation-name": "find", "tags": [ "StagesController" ], "responses": { "200": { "description": "Array of Stages model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StagesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stages.Filter1" } } } } ], "operationId": "StagesController.find" } }, "/step-rule-groups/count": { "get": { "x-controller-name": "StepRuleGroupsController", "x-operation-name": "count", "tags": [ "StepRuleGroupsController" ], "responses": { "200": { "description": "StepRuleGroups model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "StepRuleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "StepRuleGroupsController.count" } }, "/step-rule-groups/{id}": { "put": { "x-controller-name": "StepRuleGroupsController", "x-operation-name": "replaceById", "tags": [ "StepRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "StepRuleGroups PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepRuleGroups" } } }, "x-parameter-index": 1 }, "operationId": "StepRuleGroupsController.replaceById" }, "patch": { "x-controller-name": "StepRuleGroupsController", "x-operation-name": "updateById", "tags": [ "StepRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "StepRuleGroups PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepRuleGroupsPartial" } } }, "x-parameter-index": 1 }, "operationId": "StepRuleGroupsController.updateById" }, "get": { "x-controller-name": "StepRuleGroupsController", "x-operation-name": "findById", "tags": [ "StepRuleGroupsController" ], "responses": { "200": { "description": "StepRuleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepRuleGroupsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepRuleGroups.Filter" } } } } ], "operationId": "StepRuleGroupsController.findById" }, "delete": { "x-controller-name": "StepRuleGroupsController", "x-operation-name": "deleteById", "tags": [ "StepRuleGroupsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "StepRuleGroups DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "StepRuleGroupsController.deleteById" } }, "/step-rule-groups": { "post": { "x-controller-name": "StepRuleGroupsController", "x-operation-name": "create", "tags": [ "StepRuleGroupsController" ], "responses": { "200": { "description": "StepRuleGroups model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepRuleGroups" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewStepRuleGroups" } } } }, "operationId": "StepRuleGroupsController.create" }, "patch": { "x-controller-name": "StepRuleGroupsController", "x-operation-name": "updateAll", "tags": [ "StepRuleGroupsController" ], "responses": { "200": { "description": "StepRuleGroups PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "StepRuleGroups.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepRuleGroupsPartial" } } } }, "operationId": "StepRuleGroupsController.updateAll" }, "get": { "x-controller-name": "StepRuleGroupsController", "x-operation-name": "find", "tags": [ "StepRuleGroupsController" ], "responses": { "200": { "description": "Array of StepRuleGroups model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StepRuleGroupsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepRuleGroups.Filter1" } } } } ], "operationId": "StepRuleGroupsController.find" } }, "/stripe/webhook": { "post": { "x-controller-name": "StripeController", "x-operation-name": "stripeWebhookEndpoint", "tags": [ "StripeController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Stripe Webhook Endpoint" } } } } }, "requestBody": { "content": { "application/json": { "x-parser": "raw", "schema": { "type": "object" } } }, "description": "Raw Body", "required": true }, "operationId": "StripeController.stripeWebhookEndpoint" } }, "/stripe-connect/account-sessions": { "post": { "x-controller-name": "StripeConnectController", "x-operation-name": "createAccountSession", "tags": [ "StripeConnectController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "An embedded-components Account Session client secret" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" } } } } } }, "operationId": "StripeConnectController.createAccountSession" } }, "/stripe-connect/accounts/{companyId}": { "get": { "x-controller-name": "StripeConnectController", "x-operation-name": "getAccount", "tags": [ "StripeConnectController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The affiliate Stripe Connect account row, refreshed" } } } } }, "parameters": [ { "name": "companyId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "StripeConnectController.getAccount" } }, "/stripe-connect/accounts": { "post": { "x-controller-name": "StripeConnectController", "x-operation-name": "createAccount", "tags": [ "StripeConnectController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The affiliate Stripe Connect account row" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" } } } } } }, "operationId": "StripeConnectController.createAccount" } }, "/stripe-connect/test-payout": { "post": { "x-controller-name": "StripeConnectController", "x-operation-name": "testPayout", "tags": [ "StripeConnectController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The test transfer to the connected account (Phase 1 test mode only)" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId", "amountCents" ], "properties": { "companyId": { "type": "number" }, "amountCents": { "type": "number" } } } } } }, "operationId": "StripeConnectController.testPayout" } }, "/stripe-connect/test-topup": { "post": { "x-controller-name": "StripeConnectController", "x-operation-name": "testTopup", "tags": [ "StripeConnectController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The test top-up (Phase 1 test mode only)" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amountCents" ], "properties": { "amountCents": { "type": "number" } } } } } }, "operationId": "StripeConnectController.testTopup" } }, "/stripe-connect/webhook": { "post": { "x-controller-name": "StripeConnectWebhookController", "x-operation-name": "handle", "tags": [ "StripeConnectWebhookController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Stripe Connect webhook endpoint" } } } } }, "requestBody": { "content": { "application/json": { "x-parser": "raw", "schema": { "type": "object" } } }, "description": "Raw Body", "required": true }, "operationId": "StripeConnectWebhookController.handle" } }, "/stuck-stage-rules/{id}": { "patch": { "x-controller-name": "StuckStageRuleController", "x-operation-name": "updateById", "tags": [ "StuckStageRuleController" ], "responses": { "204": { "description": "Update a stuck-stage rule" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "StuckStageRuleController.updateById" }, "delete": { "x-controller-name": "StuckStageRuleController", "x-operation-name": "deleteById", "tags": [ "StuckStageRuleController" ], "responses": { "204": { "description": "Delete a stuck-stage rule" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "StuckStageRuleController.deleteById" } }, "/stuck-stage-rules": { "post": { "x-controller-name": "StuckStageRuleController", "x-operation-name": "create", "tags": [ "StuckStageRuleController" ], "responses": { "200": { "description": "Create a stuck-stage rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StuckStageRule" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "StuckStageRuleController.create" }, "get": { "x-controller-name": "StuckStageRuleController", "x-operation-name": "find", "tags": [ "StuckStageRuleController" ], "responses": { "200": { "description": "List stuck-stage rules", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StuckStageRule" } } } } } }, "operationId": "StuckStageRuleController.find" } }, "/support-canned-responses/{id}": { "patch": { "x-controller-name": "SupportCannedResponsesController", "x-operation-name": "update", "tags": [ "SupportCannedResponsesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Edit a canned response." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CannedResponsePatch" } } }, "x-parameter-index": 1 }, "operationId": "SupportCannedResponsesController.update" }, "delete": { "x-controller-name": "SupportCannedResponsesController", "x-operation-name": "archive", "tags": [ "SupportCannedResponsesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft-archive a canned response." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SupportCannedResponsesController.archive" } }, "/support-canned-responses": { "post": { "x-controller-name": "SupportCannedResponsesController", "x-operation-name": "create", "tags": [ "SupportCannedResponsesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create a canned response." } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCannedResponse" } } } }, "operationId": "SupportCannedResponsesController.create" }, "get": { "x-controller-name": "SupportCannedResponsesController", "x-operation-name": "list", "tags": [ "SupportCannedResponsesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Canned responses grouped by category (+ general)." } } } } }, "operationId": "SupportCannedResponsesController.list" } }, "/support-escalation-summary": { "post": { "x-controller-name": "SupportEscalationSummaryController", "x-operation-name": "summarize", "tags": [ "SupportEscalationSummaryController" ], "responses": { "200": { "description": "AI-summarized subject + suggested category for a ticket escalation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string" }, "category": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportEscalationSummaryRequest" } } } }, "operationId": "SupportEscalationSummaryController.summarize" } }, "/support-queue": { "get": { "x-controller-name": "SupportQueueController", "x-operation-name": "queue", "tags": [ "SupportQueueController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The full support queue (filtered, paginated)." } } } } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "priority", "in": "query", "schema": { "type": "string" } }, { "name": "assignee", "in": "query", "schema": { "type": "string" } }, { "name": "company", "in": "query", "schema": { "type": "number" } }, { "name": "flagged", "in": "query", "schema": { "type": "boolean" } }, { "name": "breached", "in": "query", "schema": { "type": "boolean" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } } ], "operationId": "SupportQueueController.queue" } }, "/support-tickets/{id}/attachments": { "post": { "x-controller-name": "SupportTicketsController", "x-operation-name": "addAttachment", "tags": [ "SupportTicketsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Link a POST /files upload to the ticket (board-attachment pattern)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSupportAttachment" } } }, "x-parameter-index": 1 }, "operationId": "SupportTicketsController.addAttachment" } }, "/support-tickets/{id}/messages": { "post": { "x-controller-name": "SupportTicketsController", "x-operation-name": "postMessage", "tags": [ "SupportTicketsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Post a reply (staff may pass internal/cannedResponseId)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSupportMessage" } } }, "x-parameter-index": 1 }, "operationId": "SupportTicketsController.postMessage" } }, "/support-tickets/{id}/read": { "post": { "x-controller-name": "SupportTicketsController", "x-operation-name": "markRead", "tags": [ "SupportTicketsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Clear the caller's side of the unread flag." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SupportTicketsController.markRead" } }, "/support-tickets/{id}/reopen": { "post": { "x-controller-name": "SupportTicketsController", "x-operation-name": "reopen", "tags": [ "SupportTicketsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Reopen a resolved ticket (restarts the first-response SLA)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SupportTicketsController.reopen" } }, "/support-tickets/{id}": { "patch": { "x-controller-name": "SupportQueueController", "x-operation-name": "update", "tags": [ "SupportQueueController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Staff mutations — each change appends an audit event." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportTicketPatch" } } }, "x-parameter-index": 1 }, "operationId": "SupportQueueController.update" }, "get": { "x-controller-name": "SupportTicketsController", "x-operation-name": "getById", "tags": [ "SupportTicketsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Ticket + thread + attachments (visibility-scoped)." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SupportTicketsController.getById" }, "delete": { "x-controller-name": "SupportQueueController", "x-operation-name": "softDelete", "tags": [ "SupportQueueController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft-delete a ticket (spam/abuse) — SuperUser only." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SupportQueueController.softDelete" } }, "/support-tickets": { "post": { "x-controller-name": "SupportTicketsController", "x-operation-name": "create", "tags": [ "SupportTicketsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create a support ticket (widget / escalation)." } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSupportTicket" } } } }, "operationId": "SupportTicketsController.create" }, "get": { "x-controller-name": "SupportTicketsController", "x-operation-name": "listMine", "tags": [ "SupportTicketsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The caller's own tickets (paginated)." } } } } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } } ], "operationId": "SupportTicketsController.listMine" } }, "/support-unread-count": { "get": { "x-controller-name": "SupportUnreadCountController", "x-operation-name": "unreadCount", "tags": [ "SupportUnreadCountController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Unread ticket counts for the caller." } } } } }, "operationId": "SupportUnreadCountController.unreadCount" } }, "/sync-dropbox": { "post": { "x-controller-name": "SyncDropboxController", "x-operation-name": "syncDropbox", "tags": [ "SyncDropboxController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Sync Dropbox" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "SyncDropboxController.syncDropbox" } }, "/t/c/{token}": { "get": { "x-controller-name": "EmailTrackingController", "x-operation-name": "click", "tags": [ "EmailTrackingController" ], "responses": { "200": { "description": "Return value of EmailTrackingController.click" } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "EmailTrackingController.click" } }, "/t/o/{token}.gif": { "get": { "x-controller-name": "EmailTrackingController", "x-operation-name": "open", "tags": [ "EmailTrackingController" ], "responses": { "200": { "description": "Return value of EmailTrackingController.open" } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "EmailTrackingController.open" } }, "/team-metrics/affiliate-managers/{userId}/schedule": { "get": { "x-controller-name": "TeamMetricsController", "x-operation-name": "affiliateManagerSchedule", "tags": [ "TeamMetricsController" ], "responses": { "200": { "description": "A roster member’s unified day/week schedule — outbound tasks (dueAt), interaction follow-ups (followupDatetime) and appointments (startsAt) bucketed into the seven Mon–Sun days of the requested week in America/New_York, plus an undated bucket. Requires CAN_VIEW_TEAM_DASHBOARDS. 404 for a userId not on that roster; 422 when weekStart is not a Monday. weekStart defaults to the current ET week.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "weekStart", "in": "query", "schema": { "type": "string" } } ], "operationId": "TeamMetricsController.affiliateManagerSchedule" } }, "/team-metrics/affiliate-managers/{userId}": { "get": { "x-controller-name": "TeamMetricsController", "x-operation-name": "affiliateManagerScorecard", "tags": [ "TeamMetricsController" ], "responses": { "200": { "description": "One affiliate-manager’s read-only scorecard: work-discipline + appointments this week PLUS bounded task/follow-up detail, plus a `trends` block of weekly flow series for the summary tiles (board #1490). Requires CAN_VIEW_TEAM_DASHBOARDS. 404 when the userId is not an affiliate manager.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TeamMetricsController.affiliateManagerScorecard" } }, "/team-metrics/affiliate-managers": { "get": { "x-controller-name": "TeamMetricsController", "x-operation-name": "affiliateManagers", "tags": [ "TeamMetricsController" ], "responses": { "200": { "description": "Affiliate-manager roster with per-person work-discipline + appointments. Accepts `?window=7|30|90` (days, default 30): `appointments.inWindow` is the rolling last-N-days count the picker drives; `appointments.thisWeek` remains the legacy ET Mon–Sun current-week count. A `trends` map carries the prior-window value per FLOW metric. Requires CAN_VIEW_TEAM_DASHBOARDS.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string" } }, { "name": "window", "in": "query", "schema": { "type": "string" } } ], "operationId": "TeamMetricsController.affiliateManagers" } }, "/team-metrics/affiliates/{userId}/schedule": { "get": { "x-controller-name": "TeamMetricsController", "x-operation-name": "affiliateSchedule", "tags": [ "TeamMetricsController" ], "responses": { "200": { "description": "A roster member’s unified day/week schedule — outbound tasks (dueAt), interaction follow-ups (followupDatetime) and appointments (startsAt) bucketed into the seven Mon–Sun days of the requested week in America/New_York, plus an undated bucket. Requires CAN_VIEW_TEAM_DASHBOARDS. 404 for a userId not on that roster; 422 when weekStart is not a Monday. weekStart defaults to the current ET week.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "weekStart", "in": "query", "schema": { "type": "string" } } ], "operationId": "TeamMetricsController.affiliateSchedule" } }, "/team-metrics/affiliates/{userId}": { "get": { "x-controller-name": "TeamMetricsController", "x-operation-name": "affiliateScorecard", "tags": [ "TeamMetricsController" ], "responses": { "200": { "description": "One affiliate’s read-only scorecard: their leaderboard metrics PLUS bounded detail — task lists, pending follow-ups, and their customers with pipeline stage — plus a `trends` block of weekly flow series for the summary tiles (board #1490). Requires CAN_VIEW_TEAM_DASHBOARDS. 404 when the userId is not an affiliate (a manager cannot probe arbitrary users).", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TeamMetricsController.affiliateScorecard" } }, "/team-metrics/affiliates": { "get": { "x-controller-name": "TeamMetricsController", "x-operation-name": "affiliates", "tags": [ "TeamMetricsController" ], "responses": { "200": { "description": "Affiliate roster with per-person work-discipline + conversion metrics, plus a `trends` map (prior-window value per FLOW metric). Accepts `?window=7|30|90` (days, default 30). Requires the CAN_VIEW_TEAM_DASHBOARDS capability.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string" } }, { "name": "window", "in": "query", "schema": { "type": "string" } } ], "operationId": "TeamMetricsController.affiliates" } }, "/team-metrics/sales-reps/{userId}/schedule": { "get": { "x-controller-name": "TeamMetricsController", "x-operation-name": "salesRepSchedule", "tags": [ "TeamMetricsController" ], "responses": { "200": { "description": "A roster member’s unified day/week schedule — outbound tasks (dueAt), interaction follow-ups (followupDatetime) and appointments (startsAt) bucketed into the seven Mon–Sun days of the requested week in America/New_York, plus an undated bucket. Requires CAN_VIEW_TEAM_DASHBOARDS. 404 for a userId not on that roster; 422 when weekStart is not a Monday. weekStart defaults to the current ET week.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "weekStart", "in": "query", "schema": { "type": "string" } } ], "operationId": "TeamMetricsController.salesRepSchedule" } }, "/team-metrics/sales-reps/{userId}": { "get": { "x-controller-name": "TeamMetricsController", "x-operation-name": "salesRepScorecard", "tags": [ "TeamMetricsController" ], "responses": { "200": { "description": "One sales rep’s read-only scorecard: their leaderboard metrics PLUS bounded detail — open/overdue/recently-completed task lists, pending follow-ups, and their customers with pipeline stage — plus a `trends` block of weekly flow series for the summary tiles (board #1490). Requires CAN_VIEW_TEAM_DASHBOARDS. 404 when the userId is not a sales rep (a manager cannot probe arbitrary users).", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TeamMetricsController.salesRepScorecard" } }, "/team-metrics/sales-reps": { "get": { "x-controller-name": "TeamMetricsController", "x-operation-name": "salesReps", "tags": [ "TeamMetricsController" ], "responses": { "200": { "description": "Sales-rep roster with per-person work-discipline + selling metrics, plus a `trends` map (prior-window value per FLOW metric). Accepts `?window=7|30|90` (days, default 30): every flow metric is computed over `[now - window, now)`. Requires the CAN_VIEW_TEAM_DASHBOARDS capability.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string" } }, { "name": "window", "in": "query", "schema": { "type": "string" } } ], "operationId": "TeamMetricsController.salesReps" } }, "/telnyx/sms/inbound": { "post": { "x-controller-name": "TelnyxWebhookController", "x-operation-name": "inbound", "tags": [ "TelnyxWebhookController" ], "responses": { "200": { "description": "Event acknowledged (empty body — Telnyx needs only a 2xx)" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "TelnyxWebhookController.inbound" } }, "/tour-states/{tourKey}": { "put": { "x-controller-name": "TourStateController", "x-operation-name": "upsertMine", "tags": [ "TourStateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Upsert the caller's state for a tour." } } } } }, "parameters": [ { "name": "tourKey", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TourStateSave" } } }, "x-parameter-index": 1 }, "operationId": "TourStateController.upsertMine" } }, "/tour-states": { "get": { "x-controller-name": "TourStateController", "x-operation-name": "findMine", "tags": [ "TourStateController" ], "responses": { "200": { "description": "All of the caller's tour-state rows.", "content": { "application/json": { "schema": { "type": "object", "properties": { "states": { "type": "array", "items": { "type": "object", "properties": { "tourKey": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "number" }, "completedAt": { "type": "string", "nullable": true } } } } } } } } } }, "operationId": "TourStateController.findMine" } }, "/tpa-company-aliases/{id}": { "delete": { "x-controller-name": "TpaReconcileController", "x-operation-name": "deleteAlias", "tags": [ "TpaReconcileController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Alias deleted" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TpaReconcileController.deleteAlias" } }, "/tpa-company-aliases": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "upsertAlias", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Created or updated alias" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "label", "companyId" ], "properties": { "label": { "type": "string" }, "companyId": { "type": "number" } } } } } }, "operationId": "TpaReconcileController.upsertAlias" }, "get": { "x-controller-name": "TpaReconcileController", "x-operation-name": "listAliases", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "All TPA company aliases", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TpaCompanyAlias" } } } } } }, "operationId": "TpaReconcileController.listAliases" } }, "/tpa-invoices/count": { "get": { "x-controller-name": "TpaInvoicesController", "x-operation-name": "count", "tags": [ "TpaInvoicesController" ], "responses": { "200": { "description": "TpaInvoices model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TpaInvoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "TpaInvoicesController.count" } }, "/tpa-invoices/reconcile/affiliate-payouts": { "get": { "x-controller-name": "TpaReconcileController", "x-operation-name": "affiliatePayouts", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "System payout + adjustment totals per recipient per invoice month" } } } } }, "operationId": "TpaReconcileController.affiliatePayouts" } }, "/tpa-invoices/reconcile/fix/delete-empty-duplicate": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "deleteEmptyDuplicate", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The empty duplicate invoice was deleted" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "invoiceId" ], "properties": { "invoiceId": { "type": "number" } } } } } }, "operationId": "TpaReconcileController.deleteEmptyDuplicate" } }, "/tpa-invoices/reconcile/fix/delete-invoice": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "deleteInvoice", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The invoice was deleted (its live transactions soft-deleted)" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "invoiceId" ], "properties": { "invoiceId": { "type": "number" }, "dryRun": { "type": "boolean" } } } } } }, "operationId": "TpaReconcileController.deleteInvoice" } }, "/tpa-invoices/reconcile/fix/overwrite-from-source/jobs/{id}": { "get": { "x-controller-name": "TpaReconcileController", "x-operation-name": "getOverwriteFromSourceJob", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Job status, plus result or error once finished" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TpaReconcileController.getOverwriteFromSourceJob" } }, "/tpa-invoices/reconcile/fix/overwrite-from-source/jobs": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "enqueueOverwriteFromSource", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The enqueued job (status pending); poll the job id" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "invoiceId" ], "properties": { "invoiceId": { "type": "number" }, "dryRun": { "type": "boolean" } } } } } }, "operationId": "TpaReconcileController.enqueueOverwriteFromSource" } }, "/tpa-invoices/reconcile/fix/overwrite-from-source": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "overwriteFromSource", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Diff summary of the fields overwritten from source" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "invoiceId" ], "properties": { "invoiceId": { "type": "number" }, "dryRun": { "type": "boolean" } } } } } }, "operationId": "TpaReconcileController.overwriteFromSource" } }, "/tpa-invoices/reconcile/fix/redate-invoice": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "redateInvoice", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The invoice (and its live transactions) were re-dated" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "invoiceId", "newInvoiceDatetime" ], "properties": { "invoiceId": { "type": "number" }, "newInvoiceDatetime": { "type": "string" }, "dryRun": { "type": "boolean" } } } } } }, "operationId": "TpaReconcileController.redateInvoice" } }, "/tpa-invoices/reconcile/from-sharefile": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "reconcileFromSharefile", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Reconcile report for a ShareFile monthly summary workbook" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "filename" ], "properties": { "filename": { "type": "string" } } } } } }, "operationId": "TpaReconcileController.reconcileFromSharefile" } }, "/tpa-invoices/reconcile/payout-workbook": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "parsePayoutWorkbookUpload", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Parsed + company-matched payout breakdown workbook" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "filename", "contentBase64" ], "properties": { "filename": { "type": "string" }, "contentBase64": { "type": "string" } } } } } }, "operationId": "TpaReconcileController.parsePayoutWorkbookUpload" } }, "/tpa-invoices/reconcile/sharefile-summaries": { "get": { "x-controller-name": "TpaReconcileController", "x-operation-name": "listSharefileSummaries", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Monthly TPA summary workbooks available in ShareFile" } } } } }, "operationId": "TpaReconcileController.listSharefileSummaries" } }, "/tpa-invoices/reconcile": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "reconcile", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Reconcile report for the uploaded TPA monthly summary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "filename", "contentBase64" ], "properties": { "filename": { "type": "string" }, "contentBase64": { "type": "string" } } } } } }, "operationId": "TpaReconcileController.reconcile" } }, "/tpa-invoices/source-reconcile/accept": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "acceptSourceDiscrepancy", "tags": [ "TpaReconcileController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Discrepancy acceptance recorded on the invoice" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "invoiceId", "fingerprint" ], "properties": { "invoiceId": { "type": "number" }, "fingerprint": { "type": "string" } } } } } }, "operationId": "TpaReconcileController.acceptSourceDiscrepancy" } }, "/tpa-invoices/source-reconcile/runs/{id}": { "get": { "x-controller-name": "TpaReconcileController", "x-operation-name": "getSourceRun", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Run status + report when done" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TpaReconcileController.getSourceRun" } }, "/tpa-invoices/source-reconcile/runs": { "post": { "x-controller-name": "TpaReconcileController", "x-operation-name": "startSourceRun", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The created run (status running)" } } } } }, "operationId": "TpaReconcileController.startSourceRun" }, "get": { "x-controller-name": "TpaReconcileController", "x-operation-name": "listSourceRuns", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Recent runs, newest first (report omitted)" } } } } }, "operationId": "TpaReconcileController.listSourceRuns" } }, "/tpa-invoices/source-reconcile/unmatched-labels": { "get": { "x-controller-name": "TpaReconcileController", "x-operation-name": "getStillUnmatchedLabels", "tags": [ "TpaReconcileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Latest run labels that are still unmapped today" } } } } }, "operationId": "TpaReconcileController.getStillUnmatchedLabels" } }, "/tpa-invoices/{id}": { "put": { "x-controller-name": "TpaInvoicesController", "x-operation-name": "replaceById", "tags": [ "TpaInvoicesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TpaInvoices PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TpaInvoices" } } }, "x-parameter-index": 1 }, "operationId": "TpaInvoicesController.replaceById" }, "patch": { "x-controller-name": "TpaInvoicesController", "x-operation-name": "updateById", "tags": [ "TpaInvoicesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TpaInvoices PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TpaInvoicesPartial" } } }, "x-parameter-index": 1 }, "operationId": "TpaInvoicesController.updateById" }, "get": { "x-controller-name": "TpaInvoicesController", "x-operation-name": "findById", "tags": [ "TpaInvoicesController" ], "responses": { "200": { "description": "TpaInvoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TpaInvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TpaInvoices.Filter" } } } } ], "operationId": "TpaInvoicesController.findById" }, "delete": { "x-controller-name": "TpaInvoicesController", "x-operation-name": "deleteById", "tags": [ "TpaInvoicesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TpaInvoices DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TpaInvoicesController.deleteById" } }, "/tpa-invoices": { "post": { "x-controller-name": "TpaInvoicesController", "x-operation-name": "create", "tags": [ "TpaInvoicesController" ], "responses": { "200": { "description": "TpaInvoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TpaInvoices" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTpaInvoices" } } } }, "operationId": "TpaInvoicesController.create" }, "patch": { "x-controller-name": "TpaInvoicesController", "x-operation-name": "updateAll", "tags": [ "TpaInvoicesController" ], "responses": { "200": { "description": "TpaInvoices PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TpaInvoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TpaInvoicesPartial" } } } }, "operationId": "TpaInvoicesController.updateAll" }, "get": { "x-controller-name": "TpaInvoicesController", "x-operation-name": "find", "tags": [ "TpaInvoicesController" ], "responses": { "200": { "description": "Array of TpaInvoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TpaInvoicesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TpaInvoices.Filter1" } } } } ], "operationId": "TpaInvoicesController.find" } }, "/training-sessions/{id}": { "patch": { "x-controller-name": "TrainingSessionsController", "x-operation-name": "updateById", "tags": [ "TrainingSessionsController" ], "responses": { "200": { "description": "The updated training session", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scheduledAt": { "type": "string", "nullable": true }, "format": { "type": "string" }, "estimatedAttendees": { "type": "number", "nullable": true }, "audienceLabel": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "contactName": { "type": "string", "nullable": true }, "specialInstructions": { "type": "string", "nullable": true }, "status": { "type": "string" }, "meetingLink": { "type": "string", "nullable": true }, "assignedUserId": { "type": "string", "nullable": true }, "employerCommSentAt": { "type": "string", "nullable": true }, "employerCommSentBy": { "type": "string", "nullable": true }, "gaCommSentAt": { "type": "string", "nullable": true }, "gaCommSentBy": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "TrainingSessionsController.updateById" }, "delete": { "x-controller-name": "TrainingSessionsController", "x-operation-name": "deleteById", "tags": [ "TrainingSessionsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Training session DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TrainingSessionsController.deleteById" } }, "/training-sessions": { "get": { "x-controller-name": "TrainingSessionsController", "x-operation-name": "listAllCompanies", "tags": [ "TrainingSessionsController" ], "responses": { "200": { "description": "Cross-company training sessions with companyName joined, optionally filtered to those needing a GA-side communication (staff only)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "needsGaComm", "in": "query", "schema": { "type": "boolean" } }, { "name": "companyId", "in": "query", "schema": { "type": "number" } } ], "operationId": "TrainingSessionsController.listAllCompanies" } }, "/transaction-status-histories/count": { "get": { "x-controller-name": "TransactionStatusHistoryController", "x-operation-name": "count", "tags": [ "TransactionStatusHistoryController" ], "responses": { "200": { "description": "TransactionStatusHistory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TransactionStatusHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "TransactionStatusHistoryController.count" } }, "/transaction-status-histories/{id}": { "put": { "x-controller-name": "TransactionStatusHistoryController", "x-operation-name": "replaceById", "tags": [ "TransactionStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TransactionStatusHistory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusHistory" } } }, "x-parameter-index": 1 }, "operationId": "TransactionStatusHistoryController.replaceById" }, "patch": { "x-controller-name": "TransactionStatusHistoryController", "x-operation-name": "updateById", "tags": [ "TransactionStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TransactionStatusHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusHistoryPartial" } } }, "x-parameter-index": 1 }, "operationId": "TransactionStatusHistoryController.updateById" }, "get": { "x-controller-name": "TransactionStatusHistoryController", "x-operation-name": "findById", "tags": [ "TransactionStatusHistoryController" ], "responses": { "200": { "description": "TransactionStatusHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusHistoryWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusHistory.Filter" } } } } ], "operationId": "TransactionStatusHistoryController.findById" }, "delete": { "x-controller-name": "TransactionStatusHistoryController", "x-operation-name": "deleteById", "tags": [ "TransactionStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TransactionStatusHistory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TransactionStatusHistoryController.deleteById" } }, "/transaction-status-histories": { "post": { "x-controller-name": "TransactionStatusHistoryController", "x-operation-name": "create", "tags": [ "TransactionStatusHistoryController" ], "responses": { "200": { "description": "TransactionStatusHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTransactionStatusHistory" } } } }, "operationId": "TransactionStatusHistoryController.create" }, "patch": { "x-controller-name": "TransactionStatusHistoryController", "x-operation-name": "updateAll", "tags": [ "TransactionStatusHistoryController" ], "responses": { "200": { "description": "TransactionStatusHistory PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TransactionStatusHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusHistoryPartial" } } } }, "operationId": "TransactionStatusHistoryController.updateAll" }, "get": { "x-controller-name": "TransactionStatusHistoryController", "x-operation-name": "find", "tags": [ "TransactionStatusHistoryController" ], "responses": { "200": { "description": "Array of TransactionStatusHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionStatusHistoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusHistory.Filter1" } } } } ], "operationId": "TransactionStatusHistoryController.find" } }, "/transaction-statuses/count": { "get": { "x-controller-name": "TransactionStatusController", "x-operation-name": "count", "tags": [ "TransactionStatusController" ], "responses": { "200": { "description": "TransactionStatus model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TransactionStatus.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "TransactionStatusController.count" } }, "/transaction-statuses/{id}": { "put": { "x-controller-name": "TransactionStatusController", "x-operation-name": "replaceById", "tags": [ "TransactionStatusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TransactionStatus PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatus" } } }, "x-parameter-index": 1 }, "operationId": "TransactionStatusController.replaceById" }, "patch": { "x-controller-name": "TransactionStatusController", "x-operation-name": "updateById", "tags": [ "TransactionStatusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TransactionStatus PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusPartial" } } }, "x-parameter-index": 1 }, "operationId": "TransactionStatusController.updateById" }, "get": { "x-controller-name": "TransactionStatusController", "x-operation-name": "findById", "tags": [ "TransactionStatusController" ], "responses": { "200": { "description": "TransactionStatus model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatus.Filter" } } } } ], "operationId": "TransactionStatusController.findById" }, "delete": { "x-controller-name": "TransactionStatusController", "x-operation-name": "deleteById", "tags": [ "TransactionStatusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TransactionStatus DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TransactionStatusController.deleteById" } }, "/transaction-statuses": { "post": { "x-controller-name": "TransactionStatusController", "x-operation-name": "create", "tags": [ "TransactionStatusController" ], "responses": { "200": { "description": "TransactionStatus model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTransactionStatus" } } } }, "operationId": "TransactionStatusController.create" }, "patch": { "x-controller-name": "TransactionStatusController", "x-operation-name": "updateAll", "tags": [ "TransactionStatusController" ], "responses": { "200": { "description": "TransactionStatus PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TransactionStatus.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusPartial" } } } }, "operationId": "TransactionStatusController.updateAll" }, "get": { "x-controller-name": "TransactionStatusController", "x-operation-name": "find", "tags": [ "TransactionStatusController" ], "responses": { "200": { "description": "Array of TransactionStatus model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionStatusWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatus.Filter1" } } } } ], "operationId": "TransactionStatusController.find" } }, "/transactions/count": { "get": { "x-controller-name": "TransactionController", "x-operation-name": "count", "tags": [ "TransactionController" ], "responses": { "200": { "description": "Transaction model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Transaction.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "TransactionController.count" } }, "/transactions/{id}/invoice-token": { "get": { "x-controller-name": "TransactionController", "x-operation-name": "invoiceToken", "tags": [ "TransactionController" ], "responses": { "200": { "description": "Short-lived capability token for rendering this transaction invoice", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TransactionController.invoiceToken" } }, "/transactions/{id}": { "put": { "x-controller-name": "TransactionController", "x-operation-name": "replaceById", "tags": [ "TransactionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Transaction PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } } }, "x-parameter-index": 1 }, "operationId": "TransactionController.replaceById" }, "patch": { "x-controller-name": "TransactionController", "x-operation-name": "updateById", "tags": [ "TransactionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Transaction PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "paperworkOverrideReason", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionPartial" } } }, "x-parameter-index": 1 }, "operationId": "TransactionController.updateById" }, "get": { "x-controller-name": "TransactionController", "x-operation-name": "findById", "tags": [ "TransactionController" ], "responses": { "200": { "description": "Transaction model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction.Filter" } } } } ], "operationId": "TransactionController.findById" }, "delete": { "x-controller-name": "TransactionController", "x-operation-name": "deleteById", "tags": [ "TransactionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Transaction DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TransactionController.deleteById" } }, "/transactions": { "post": { "x-controller-name": "TransactionController", "x-operation-name": "create", "tags": [ "TransactionController" ], "responses": { "200": { "description": "Transaction model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTransaction" } } } }, "operationId": "TransactionController.create" }, "patch": { "x-controller-name": "TransactionController", "x-operation-name": "updateAll", "tags": [ "TransactionController" ], "responses": { "200": { "description": "Transaction PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Transaction.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionPartial" } } } }, "operationId": "TransactionController.updateAll" }, "get": { "x-controller-name": "TransactionController", "x-operation-name": "find", "tags": [ "TransactionController" ], "responses": { "200": { "description": "Array of Transaction model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction.Filter1" } } } } ], "operationId": "TransactionController.find" } }, "/transactions-clean": { "get": { "x-controller-name": "TransactionController", "x-operation-name": "findClean", "tags": [ "TransactionController" ], "responses": { "200": { "description": "Array of Transaction model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction.Filter1" } } } } ], "operationId": "TransactionController.findClean" } }, "/transactions-new/count": { "get": { "x-controller-name": "TransactionsNewController", "x-operation-name": "count", "tags": [ "TransactionsNewController" ], "responses": { "200": { "description": "TransactionNew count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TransactionNew.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "TransactionsNewController.count" } }, "/transactions-new/{id}/reverse": { "post": { "x-controller-name": "TransactionsNewController", "x-operation-name": "reverse", "tags": [ "TransactionsNewController" ], "responses": { "200": { "description": "The reversed obligation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionNew" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "reason" ], "properties": { "reason": { "type": "string", "minLength": 1 } } } } }, "x-parameter-index": 1 }, "operationId": "TransactionsNewController.reverse" } }, "/transactions-new/{id}/take-over": { "post": { "x-controller-name": "TransactionsNewController", "x-operation-name": "takeOver", "tags": [ "TransactionsNewController" ], "responses": { "200": { "description": "The obligation, now sourced by GroupAdvisors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionNew" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string" } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "TransactionsNewController.takeOver" } }, "/transactions-new/{id}": { "get": { "x-controller-name": "TransactionsNewController", "x-operation-name": "findById", "tags": [ "TransactionsNewController" ], "responses": { "200": { "description": "A TransactionNew instance with its billing-event timeline", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TransactionNewWithRelations" }, { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/BillingEvent" } } } } ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TransactionsNewController.findById" } }, "/transactions-new": { "post": { "x-controller-name": "TransactionsNewController", "x-operation-name": "create", "tags": [ "TransactionsNewController" ], "responses": { "200": { "description": "The created obligation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionNew" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTransactionNew" } } } }, "operationId": "TransactionsNewController.create" }, "get": { "x-controller-name": "TransactionsNewController", "x-operation-name": "find", "tags": [ "TransactionsNewController" ], "responses": { "200": { "description": "Array of TransactionNew instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionNewWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionNew.Filter" } } } } ], "operationId": "TransactionsNewController.find" } }, "/trigger-affiliate-registration": { "post": { "x-controller-name": "RegistrationController", "x-operation-name": "triggerAffiliateRegistration", "tags": [ "RegistrationController" ], "responses": { "200": { "description": "Affiliate Registration", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "company": { "type": "string" }, "phoneNumber": { "type": "string" }, "utm": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "utm": { "type": "string" }, "defaultProcessflowId": { "type": "number" } } } } } }, "operationId": "RegistrationController.triggerAffiliateRegistration" } }, "/twilio/sms/inbound": { "post": { "x-controller-name": "TwilioWebhookController", "x-operation-name": "inbound", "tags": [ "TwilioWebhookController" ], "responses": { "200": { "description": "TwiML response to an inbound Twilio SMS", "content": { "text/xml": { "schema": { "type": "string" } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "TwilioWebhookController.inbound" } }, "/user-companies/count": { "get": { "x-controller-name": "UserCompanyController", "x-operation-name": "count", "tags": [ "UserCompanyController" ], "responses": { "200": { "description": "UserCompany model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "UserCompany.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserCompanyController.count" } }, "/user-companies/{id}": { "put": { "x-controller-name": "UserCompanyController", "x-operation-name": "replaceById", "tags": [ "UserCompanyController" ], "responses": { "204": { "description": "UserCompany PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCompany" } } }, "x-parameter-index": 1 }, "operationId": "UserCompanyController.replaceById" }, "patch": { "x-controller-name": "UserCompanyController", "x-operation-name": "updateById", "tags": [ "UserCompanyController" ], "responses": { "204": { "description": "UserCompany PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCompanyPartial" } } }, "x-parameter-index": 1 }, "operationId": "UserCompanyController.updateById" }, "get": { "x-controller-name": "UserCompanyController", "x-operation-name": "findById", "tags": [ "UserCompanyController" ], "responses": { "200": { "description": "UserCompany model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCompanyWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCompany.Filter" } } } } ], "operationId": "UserCompanyController.findById" }, "delete": { "x-controller-name": "UserCompanyController", "x-operation-name": "deleteById", "tags": [ "UserCompanyController" ], "responses": { "204": { "description": "UserCompany DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserCompanyController.deleteById" } }, "/user-companies": { "post": { "x-controller-name": "UserCompanyController", "x-operation-name": "create", "tags": [ "UserCompanyController" ], "responses": { "200": { "description": "UserCompany model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCompany" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserCompany" } } } }, "operationId": "UserCompanyController.create" }, "get": { "x-controller-name": "UserCompanyController", "x-operation-name": "find", "tags": [ "UserCompanyController" ], "responses": { "200": { "description": "Array of UserCompany model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserCompanyWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCompany.Filter1" } } } } ], "operationId": "UserCompanyController.find" } }, "/user-levels/count": { "get": { "x-controller-name": "UserLevelController", "x-operation-name": "count", "tags": [ "UserLevelController" ], "responses": { "200": { "description": "UserLevel model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "UserLevel.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserLevelController.count" } }, "/user-levels/{id}": { "put": { "x-controller-name": "UserLevelController", "x-operation-name": "replaceById", "tags": [ "UserLevelController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "UserLevel PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLevel" } } }, "x-parameter-index": 1 }, "operationId": "UserLevelController.replaceById" }, "patch": { "x-controller-name": "UserLevelController", "x-operation-name": "updateById", "tags": [ "UserLevelController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "UserLevel PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLevelPartial" } } }, "x-parameter-index": 1 }, "operationId": "UserLevelController.updateById" }, "get": { "x-controller-name": "UserLevelController", "x-operation-name": "findById", "tags": [ "UserLevelController" ], "responses": { "200": { "description": "UserLevel model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLevelWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLevel.Filter" } } } } ], "operationId": "UserLevelController.findById" }, "delete": { "x-controller-name": "UserLevelController", "x-operation-name": "deleteById", "tags": [ "UserLevelController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "UserLevel DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserLevelController.deleteById" } }, "/user-levels": { "post": { "x-controller-name": "UserLevelController", "x-operation-name": "create", "tags": [ "UserLevelController" ], "responses": { "200": { "description": "UserLevel model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLevel" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserLevel" } } } }, "operationId": "UserLevelController.create" }, "get": { "x-controller-name": "UserLevelController", "x-operation-name": "find", "tags": [ "UserLevelController" ], "responses": { "200": { "description": "Array of UserLevel model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserLevelWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLevel.Filter1" } } } } ], "operationId": "UserLevelController.find" } }, "/user-settings/count": { "get": { "x-controller-name": "SettingsController", "x-operation-name": "count", "tags": [ "SettingsController" ], "responses": { "200": { "description": "UserSettings model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "UserSettings.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "SettingsController.count" } }, "/user-settings/{id}": { "put": { "x-controller-name": "SettingsController", "x-operation-name": "replaceById", "tags": [ "SettingsController" ], "responses": { "204": { "description": "UserSettings PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettings" } } }, "x-parameter-index": 1 }, "operationId": "SettingsController.replaceById" }, "patch": { "x-controller-name": "SettingsController", "x-operation-name": "updateById", "tags": [ "SettingsController" ], "responses": { "204": { "description": "UserSettings PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsPartial" } } }, "x-parameter-index": 1 }, "operationId": "SettingsController.updateById" }, "get": { "x-controller-name": "SettingsController", "x-operation-name": "findById", "tags": [ "SettingsController" ], "responses": { "200": { "description": "UserSettings model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettings.Filter" } } } } ], "operationId": "SettingsController.findById" }, "delete": { "x-controller-name": "SettingsController", "x-operation-name": "deleteById", "tags": [ "SettingsController" ], "responses": { "204": { "description": "UserSettings DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SettingsController.deleteById" } }, "/user-settings": { "post": { "x-controller-name": "SettingsController", "x-operation-name": "create", "tags": [ "SettingsController" ], "responses": { "200": { "description": "UserSettings model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettings" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserSettings" } } } }, "operationId": "SettingsController.create" }, "patch": { "x-controller-name": "SettingsController", "x-operation-name": "updateAll", "tags": [ "SettingsController" ], "responses": { "200": { "description": "UserSettings PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "UserSettings.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsPartial" } } } }, "operationId": "SettingsController.updateAll" }, "get": { "x-controller-name": "SettingsController", "x-operation-name": "find", "tags": [ "SettingsController" ], "responses": { "200": { "description": "Array of UserSettings model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSettingsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettings.Filter1" } } } } ], "operationId": "SettingsController.find" } }, "/users/by-ids": { "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "findByIds", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Array of marshalled ClearErcUser rows matching the given ids. Same per-row `roleGroups` scrub as GET /users/{id} — board #3478.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarshalledUserWithRelations" } } } } } }, "parameters": [ { "name": "ids", "in": "query", "schema": { "type": "string" } } ], "operationId": "ClearErcUsersController.findByIds" } }, "/users/count": { "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "count", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "User model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "User.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ClearErcUsersController.count" } }, "/users/login": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "login", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Token", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "refreshToken": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "user": { "type": "object" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "username", "password" ], "properties": { "email": { "type": "string" }, "password": { "type": "string", "minLength": 8 }, "turnstileToken": { "type": "string" } } } } }, "description": "The input of login function", "required": true }, "operationId": "ClearErcUsersController.login" } }, "/users/logout": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "logout", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Log out — revokes the presented refresh token's sessions", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "refreshToken": { "type": "string" } } } } }, "description": "Refresh token to revoke on logout", "required": false }, "operationId": "ClearErcUsersController.logout" } }, "/users/me/capabilities": { "get": { "x-controller-name": "CapabilitiesController", "x-operation-name": "myCapabilities", "tags": [ "CapabilitiesController" ], "responses": { "200": { "description": "The authenticated caller's flat capability-name set", "content": { "application/json": { "schema": { "type": "object", "properties": { "capabilities": { "type": "array", "items": { "type": "string" } } } } } } } }, "operationId": "CapabilitiesController.myCapabilities" } }, "/users/resend-verification/{id}": { "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "resendVerificationById", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Resend Verification", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "site", "in": "query", "schema": { "type": "string" } } ], "operationId": "ClearErcUsersController.resendVerificationById" } }, "/users/reset/{email}": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "resetPassword", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Return value of ClearErcUsersController.resetPassword" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "site" ], "properties": { "site": { "type": "string" }, "email": { "type": "string" } } } } }, "description": "Required input for sending emails", "required": true }, "operationId": "ClearErcUsersController.resetPassword" } }, "/users/reset-do/{id}/{token}": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "resetPasswordDo", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "type": "object", "properties": { "done": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPartial" } } }, "x-parameter-index": 2 }, "operationId": "ClearErcUsersController.resetPasswordDo" } }, "/users/set-first-password": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "setFirstPassword", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "The CALLER, re-read and marshalled (no relations)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUser" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string", "minLength": 8 }, "currentRefreshToken": { "type": "string" } } } } }, "description": "Set a first password on the CALLER’s own password-less account. Deliberately carries no user identifier — the target is the JWT principal.", "required": true }, "operationId": "ClearErcUsersController.setFirstPassword" } }, "/users/signup": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "signUp", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUser" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUser" } } } }, "operationId": "ClearErcUsersController.signUp" } }, "/users/signup-affiliate": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "signUpAffiliate", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUser" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUser" } } } }, "operationId": "ClearErcUsersController.signUpAffiliate" } }, "/users/signup-sa": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "signUpSA", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUser" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUser" } } } }, "operationId": "ClearErcUsersController.signUpSA" } }, "/users/signup-tariff": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "signUpTariff", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Result of Signing Up For Tariff Relief", "content": { "application/json": { "schema": { "schema": { "$ref": "#/components/schemas/Response" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTariffUser" } } } }, "operationId": "ClearErcUsersController.signUpTariff" } }, "/users/verification/{id}/{token}": { "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "findVerificationById", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Verify Token", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "site", "in": "query", "schema": { "type": "string" } } ], "operationId": "ClearErcUsersController.findVerificationById" } }, "/users/{id}/auth": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "authAsUser", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "User model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object" }, "token": { "type": "string" }, "refreshToken": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ClearErcUsersController.authAsUser" } }, "/users/{userId}/devices/{deviceUuid}": { "delete": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "revokeUserDevice", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "SUPER-USER: revoke any user's device", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "deviceUuid", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ClearErcUsersController.revokeUserDevice" } }, "/users/{userId}/devices": { "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "listUserDevices", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "SUPER-USER: any user's registered devices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } } } }, "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ClearErcUsersController.listUserDevices" } }, "/users/{id}/notification-consent": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "setNotificationConsent", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Record first-login notification consent + terms acceptance", "content": { "application/json": { "schema": { "type": "object", "properties": { "done": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "termsVersionAccepted": { "type": "string" }, "categoryConsent": { "type": "object" }, "consentName": { "type": "string" }, "consentTimezone": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "ClearErcUsersController.setNotificationConsent" } }, "/users/{id}/notification-consent-log": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "appendNotificationConsentLog", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Append an immutable consent-attestation row (login or Settings-side channel enable)", "content": { "application/json": { "schema": { "type": "object", "properties": { "done": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "string" }, "channel": { "type": "string" }, "action": { "type": "string" }, "termsVersionAccepted": { "type": "string" }, "consentName": { "type": "string" }, "categoryConsent": { "type": "object" } } } } }, "x-parameter-index": 1 }, "operationId": "ClearErcUsersController.appendNotificationConsentLog" } }, "/users/{id}/replace-company-roles": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "replaceCompanyRoles", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "The target user, re-read and marshalled. Relations are populated (defaultUserIncludes), and `roleGroups` gets the same #3478 scrub as GET /users/{id}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUserWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" }, "roleIds": { "type": "array", "items": { "type": "number" } } } } } }, "description": "Replace company roles", "required": true, "x-parameter-index": 1 }, "operationId": "ClearErcUsersController.replaceCompanyRoles" } }, "/users/{id}/replace-global-roles": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "replaceGlobalRoles", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "The target user, re-read and marshalled. Relations are populated (defaultUserIncludes), so `roleGroups` may be present.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUserWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "roleIds" ], "properties": { "roleIds": { "type": "array", "items": { "type": "number" } } } } } }, "description": "Replace global roles", "required": true, "x-parameter-index": 1 }, "operationId": "ClearErcUsersController.replaceGlobalRoles" } }, "/users/{id}/resend-invitation": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "resendInvitation", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Invitation reissued. `sent` is the only confirmation of delivery; `withheld` means the recipient is suppressed and the rotation was rolled back.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sent": { "type": "boolean" }, "withheld": { "type": "boolean" }, "restored": { "type": "boolean" }, "withheldReason": { "type": "string" }, "messageId": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "site": { "type": "string" } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "ClearErcUsersController.resendInvitation" } }, "/users/{id}/reset-password": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "adminResetPassword", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "The target user, re-read and marshalled (no relations)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUser" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string", "minLength": 8 }, "currentPassword": { "type": "string" }, "currentRefreshToken": { "type": "string" } } } } }, "description": "Admin reset user password", "required": true, "x-parameter-index": 1 }, "operationId": "ClearErcUsersController.adminResetPassword" } }, "/users/{id}/roles": { "post": { "x-controller-name": "UserRolesController", "x-operation-name": "create", "tags": [ "UserRolesController" ], "responses": { "200": { "description": "create a Roles model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRolesInUser" } } }, "x-parameter-index": 1 }, "operationId": "UserRolesController.create" }, "patch": { "x-controller-name": "UserRolesController", "x-operation-name": "patch", "tags": [ "UserRolesController" ], "responses": { "200": { "description": "User.Roles PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Roles.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesPartial" } } }, "x-parameter-index": 1 }, "operationId": "UserRolesController.patch" }, "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "findRolesByUserId", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Role model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ClearErcUsersController.findRolesByUserId" }, "delete": { "x-controller-name": "UserRolesController", "x-operation-name": "delete", "tags": [ "UserRolesController" ], "responses": { "200": { "description": "User.Roles DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Roles.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserRolesController.delete" } }, "/users/{id}": { "patch": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "updateById", "tags": [ "ClearErcUsersController" ], "responses": { "204": { "description": "User PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPartial" } } }, "x-parameter-index": 1 }, "operationId": "ClearErcUsersController.updateById" }, "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "findUserById", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "A marshalled ClearErcUser row. `roleGroups` is present only for the caller's own row or a caller who administers users — board #3478.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUserWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ClearErcUsersController.findUserById" }, "delete": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "deleteById", "tags": [ "ClearErcUsersController" ], "responses": { "204": { "description": "User DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ClearErcUsersController.deleteById" } }, "/users": { "post": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "create", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "The marshalled ClearErcUser row that was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarshalledUser" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ClearErcUsersController.create" }, "patch": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "updateAll", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "User PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "User.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPartial" } } } }, "operationId": "ClearErcUsersController.updateAll" }, "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "find", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Array of marshalled ClearErcUser rows. `roleGroups` is present only for a privileged caller (SuperUser / ADD_USER / URL_ADMIN) or on the caller's own row — board #3478.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarshalledUserWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Filter" } } } }, { "name": "role", "in": "query", "schema": { "type": "string" } } ], "operationId": "ClearErcUsersController.find" } }, "/utm-links/by-code/{code}": { "get": { "x-controller-name": "UtmLinksController", "x-operation-name": "findByCode", "tags": [ "UtmLinksController" ], "responses": { "200": { "description": "Minimal {code, owner} attribution pair for one exact UTM code (admin, JWT)", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "owner": { "type": "string" } } } } } } }, "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "UtmLinksController.findByCode" } }, "/utm-links/count": { "get": { "x-controller-name": "UtmLinksController", "x-operation-name": "count", "tags": [ "UtmLinksController" ], "responses": { "200": { "description": "UtmLinks model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "UtmLinks.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UtmLinksController.count" } }, "/utm-links/{id}": { "put": { "x-controller-name": "UtmLinksController", "x-operation-name": "replaceById", "tags": [ "UtmLinksController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "UtmLinks PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLinks" } } }, "x-parameter-index": 1 }, "operationId": "UtmLinksController.replaceById" }, "patch": { "x-controller-name": "UtmLinksController", "x-operation-name": "updateById", "tags": [ "UtmLinksController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "UtmLinks PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLinksPartial" } } }, "x-parameter-index": 1 }, "operationId": "UtmLinksController.updateById" }, "get": { "x-controller-name": "UtmLinksController", "x-operation-name": "findById", "tags": [ "UtmLinksController" ], "responses": { "200": { "description": "UtmLinks model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLinksWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLinks.Filter" } } } } ], "operationId": "UtmLinksController.findById" }, "delete": { "x-controller-name": "UtmLinksController", "x-operation-name": "deleteById", "tags": [ "UtmLinksController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "UtmLinks DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "UtmLinksController.deleteById" } }, "/utm-links": { "post": { "x-controller-name": "UtmLinksController", "x-operation-name": "create", "tags": [ "UtmLinksController" ], "responses": { "200": { "description": "UtmLinks model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLinks" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUtmLinks" } } } }, "operationId": "UtmLinksController.create" }, "patch": { "x-controller-name": "UtmLinksController", "x-operation-name": "updateAll", "tags": [ "UtmLinksController" ], "responses": { "200": { "description": "UtmLinks PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "UtmLinks.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLinksPartial" } } } }, "operationId": "UtmLinksController.updateAll" }, "get": { "x-controller-name": "UtmLinksController", "x-operation-name": "find", "tags": [ "UtmLinksController" ], "responses": { "200": { "description": "Array of UtmLinks model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UtmLinksWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLinks.Filter1" } } } } ], "operationId": "UtmLinksController.find" } }, "/utm-logs/count": { "get": { "x-controller-name": "UtmLogsController", "x-operation-name": "count", "tags": [ "UtmLogsController" ], "responses": { "200": { "description": "UtmLog model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "UtmLog.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UtmLogsController.count" } }, "/utm-logs/{id}": { "put": { "x-controller-name": "UtmLogsController", "x-operation-name": "replaceById", "tags": [ "UtmLogsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "UtmLog PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLog" } } }, "x-parameter-index": 1 }, "operationId": "UtmLogsController.replaceById" }, "patch": { "x-controller-name": "UtmLogsController", "x-operation-name": "updateById", "tags": [ "UtmLogsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "UtmLog PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLogPartial" } } }, "x-parameter-index": 1 }, "operationId": "UtmLogsController.updateById" }, "get": { "x-controller-name": "UtmLogsController", "x-operation-name": "findById", "tags": [ "UtmLogsController" ], "responses": { "200": { "description": "UtmLog model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLogWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLog.Filter" } } } } ], "operationId": "UtmLogsController.findById" }, "delete": { "x-controller-name": "UtmLogsController", "x-operation-name": "deleteById", "tags": [ "UtmLogsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "UtmLog DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UtmLogsController.deleteById" } }, "/utm-logs": { "post": { "x-controller-name": "UtmLogsController", "x-operation-name": "create", "tags": [ "UtmLogsController" ], "responses": { "200": { "description": "UtmLog model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLog" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUtmLog" } } } }, "operationId": "UtmLogsController.create" }, "patch": { "x-controller-name": "UtmLogsController", "x-operation-name": "updateAll", "tags": [ "UtmLogsController" ], "responses": { "200": { "description": "UtmLog PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "UtmLog.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLogPartial" } } } }, "operationId": "UtmLogsController.updateAll" }, "get": { "x-controller-name": "UtmLogsController", "x-operation-name": "find", "tags": [ "UtmLogsController" ], "responses": { "200": { "description": "Array of UtmLog model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UtmLogWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmLog.Filter1" } } } } ], "operationId": "UtmLogsController.find" } }, "/version": { "get": { "x-controller-name": "VersionController", "x-operation-name": "version", "tags": [ "VersionController" ], "responses": { "200": { "description": "Deployed app version", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string" } } } } } } }, "operationId": "VersionController.version" }, "head": { "x-controller-name": "VersionController", "x-operation-name": "versionHead", "tags": [ "VersionController" ], "responses": { "200": { "description": "Deployed app version (headers only)" } }, "operationId": "VersionController.versionHead" } }, "/video-catalogs/voices/{voiceId}/sample/stream": { "get": { "x-controller-name": "VideoCatalogController", "x-operation-name": "streamVoiceSample", "tags": [ "VideoCatalogController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "voiceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "VideoCatalogController.streamVoiceSample" } }, "/video-catalogs/voices/{voiceId}/sample": { "post": { "x-controller-name": "VideoCatalogController", "x-operation-name": "ensureVoiceSampleForVoice", "tags": [ "VideoCatalogController" ], "responses": { "200": { "description": "Ensures the voice sample exists; generated=false when cached", "content": { "application/json": { "schema": { "type": "object", "required": [ "s3Key", "generated" ], "properties": { "s3Key": { "type": "string" }, "generated": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "voiceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "VideoCatalogController.ensureVoiceSampleForVoice" } }, "/video-catalogs": { "get": { "x-controller-name": "VideoCatalogController", "x-operation-name": "catalog", "tags": [ "VideoCatalogController" ], "responses": { "200": { "description": "The synced provider catalog (voices + models)", "content": { "application/json": { "schema": { "type": "object", "properties": { "models": { "type": "array", "items": { "type": "object", "properties": { "jobType": { "type": "string" }, "displayName": { "type": "string" }, "type": { "type": "string" } } } }, "voices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "voiceType": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "sampleUrl": { "type": "string", "nullable": true } } } }, "syncedAt": { "type": "string", "nullable": true }, "provider": { "type": "string" } } } } } } }, "operationId": "VideoCatalogController.catalog" } }, "/video-credits/summary": { "get": { "x-controller-name": "VideoRenderController", "x-operation-name": "creditsSummary", "tags": [ "VideoRenderController" ], "responses": { "200": { "description": "Section-wide running credit spend (SUM of the append-only ledger)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "VideoRenderController.creditsSummary" } }, "/videos/{id}/archive": { "post": { "x-controller-name": "VideoStudioController", "x-operation-name": "archive", "tags": [ "VideoStudioController" ], "responses": { "200": { "description": "The archived (soft-deleted) video", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoStudioController.archive" } }, "/videos/{id}/concept-messages": { "post": { "x-controller-name": "VideoConceptController", "x-operation-name": "postConceptMessage", "tags": [ "VideoConceptController" ], "responses": { "200": { "description": "The human turn and the agent reply that answered it", "content": { "application/json": { "schema": { "type": "object", "properties": { "humanMessage": { "type": "object" }, "agentMessage": { "type": "object" }, "status": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoConceptMessageRequest" } } }, "x-parameter-index": 1 }, "operationId": "VideoConceptController.postConceptMessage" }, "get": { "x-controller-name": "VideoConceptController", "x-operation-name": "listConceptMessages", "tags": [ "VideoConceptController" ], "responses": { "200": { "description": "The concept Q&A thread for a video, oldest first", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoConceptController.listConceptMessages" } }, "/videos/{id}/render-estimate": { "get": { "x-controller-name": "VideoCatalogController", "x-operation-name": "renderEstimate", "tags": [ "VideoCatalogController" ], "responses": { "200": { "description": "The per-render credit estimate for a video and its options", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "video": { "type": "number" }, "speech": { "type": "number" }, "music": { "type": "number" }, "tier": { "type": "object", "properties": { "jobType": { "type": "string" }, "displayName": { "type": "string" }, "segmentSeconds": { "type": "number" }, "creditsPerSegment720p": { "type": "number" }, "creditsPerSegment1080p": { "type": "number", "nullable": true }, "supportsResolution": { "type": "boolean" } } }, "ratePerSegment": { "type": "number" }, "takeCount": { "type": "number" }, "perTakeVideo": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "style", "in": "query", "schema": { "type": "string" }, "description": "Override style (photo_real, illustrated_explainer, animated_3d)." }, { "name": "quality", "in": "query", "schema": { "type": "string" }, "description": "Override quality (test, production)." }, { "name": "resolution", "in": "query", "schema": { "type": "string" }, "description": "Override resolution (720p, 1080p)." }, { "name": "takeCount", "in": "query", "schema": { "type": "number" }, "description": "Override take count (1-4)." } ], "operationId": "VideoCatalogController.renderEstimate" } }, "/videos/{id}/renders": { "post": { "x-controller-name": "VideoRenderController", "x-operation-name": "enqueueRenders", "tags": [ "VideoRenderController" ], "responses": { "200": { "description": "Enqueued render — the created takes, video now `rendering`", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoRenderController.enqueueRenders" } }, "/videos/{id}/scene-renders": { "get": { "x-controller-name": "VideoRenderController", "x-operation-name": "listSceneRenders", "tags": [ "VideoRenderController" ], "responses": { "200": { "description": "Per-scene candidate clip/still jobs (take-less), newest first", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoRenderController.listSceneRenders" } }, "/videos/{id}/scenes/{sceneIndex}/renders": { "post": { "x-controller-name": "VideoRenderController", "x-operation-name": "enqueueSceneRender", "tags": [ "VideoRenderController" ], "responses": { "200": { "description": "Enqueued single-scene candidate render — the created clip job", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "sceneIndex", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SceneRenderRequest" } } }, "required": false, "x-parameter-index": 2 }, "operationId": "VideoRenderController.enqueueSceneRender" } }, "/videos/{id}/scenes/{sceneIndex}/settings": { "patch": { "x-controller-name": "VideoRenderController", "x-operation-name": "patchSceneSettings", "tags": [ "VideoRenderController" ], "responses": { "200": { "description": "The scene's persisted per-scene render settings after the patch", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "sceneIndex", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SceneSettingsRequest" } } }, "required": true, "x-parameter-index": 2 }, "operationId": "VideoRenderController.patchSceneSettings" } }, "/videos/{id}/script/generate": { "post": { "x-controller-name": "VideoScriptController", "x-operation-name": "generate", "tags": [ "VideoScriptController" ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "description": "Accepted — a script-generation job was enqueued; the video advances asynchronously. Poll GET /videos/{id} (scriptGenerating) or GET /videos/{id}/scripts for the new version." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoScriptController.generate" } }, "/videos/{id}/scripts/{versionId}/approve": { "post": { "x-controller-name": "VideoScriptController", "x-operation-name": "approve", "tags": [ "VideoScriptController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The approved (locked) script version; the video advances to options" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "versionId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoScriptController.approve" } }, "/videos/{id}/scripts/{versionId}/revise": { "post": { "x-controller-name": "VideoScriptController", "x-operation-name": "revise", "tags": [ "VideoScriptController" ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "description": "Accepted — a script-revision job was enqueued; a new version is produced asynchronously. Poll GET /videos/{id} (scriptGenerating) or GET /videos/{id}/scripts." } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "versionId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoScriptReviseRequest" } } }, "x-parameter-index": 2 }, "operationId": "VideoScriptController.revise" } }, "/videos/{id}/scripts/{versionId}/scenes/{sceneIndex}/amendments": { "post": { "x-controller-name": "VideoScriptController", "x-operation-name": "amendScene", "tags": [ "VideoScriptController" ], "responses": { "200": { "description": "The created scene amendment (board #3039) + the resulting effective storyboard. The stored approved storyboard blob is never modified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoScriptSceneAmendmentResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "versionId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "sceneIndex", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoScriptSceneAmendmentRequest" } } }, "x-parameter-index": 3 }, "operationId": "VideoScriptController.amendScene" } }, "/videos/{id}/scripts/{versionId}": { "patch": { "x-controller-name": "VideoScriptController", "x-operation-name": "handEdit", "tags": [ "VideoScriptController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Hand-edited script version + its validation" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "versionId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoScriptHandEditRequest" } } }, "x-parameter-index": 2 }, "operationId": "VideoScriptController.handEdit" }, "get": { "x-controller-name": "VideoScriptController", "x-operation-name": "getOne", "tags": [ "VideoScriptController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "One script version, full" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "versionId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoScriptController.getOne" } }, "/videos/{id}/scripts": { "get": { "x-controller-name": "VideoScriptController", "x-operation-name": "list", "tags": [ "VideoScriptController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "All script versions for a video (summaries)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoScriptController.list" } }, "/videos/{id}/takes/{takeId}/compose": { "post": { "x-controller-name": "VideoRenderController", "x-operation-name": "composeTake", "tags": [ "VideoRenderController" ], "responses": { "200": { "description": "Compose a NEW take from a ready base take with per-scene candidate overrides", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "takeId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComposeTakeRequest" } } }, "required": true, "x-parameter-index": 2 }, "operationId": "VideoRenderController.composeTake" } }, "/videos/{id}/takes/{takeId}/playback-token": { "get": { "x-controller-name": "VideoTakePlaybackController", "x-operation-name": "playbackToken", "tags": [ "VideoTakePlaybackController" ], "responses": { "200": { "description": "Return value of VideoTakePlaybackController.playbackToken" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "takeId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoTakePlaybackController.playbackToken" } }, "/videos/{id}/takes/{takeId}/retry": { "post": { "x-controller-name": "VideoRenderController", "x-operation-name": "retryTake", "tags": [ "VideoRenderController" ], "responses": { "200": { "description": "Re-render one failed take as a new take", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "takeId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoRenderController.retryTake" } }, "/videos/{id}/takes/{takeId}/sign-off": { "post": { "x-controller-name": "VideoRenderController", "x-operation-name": "signOff", "tags": [ "VideoRenderController" ], "responses": { "200": { "description": "Sign off a ready take — video → approved", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "takeId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoRenderController.signOff" } }, "/videos/{id}/takes/{takeId}/stream": { "get": { "x-controller-name": "VideoTakePlaybackController", "x-operation-name": "stream", "tags": [ "VideoTakePlaybackController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "takeId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "token", "in": "query", "schema": { "type": "string" } } ], "operationId": "VideoTakePlaybackController.stream" }, "head": { "x-controller-name": "VideoTakePlaybackController", "x-operation-name": "streamHead", "tags": [ "VideoTakePlaybackController" ], "responses": { "200": { "description": "Return value of VideoTakePlaybackController.streamHead" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "takeId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "token", "in": "query", "schema": { "type": "string" } } ], "operationId": "VideoTakePlaybackController.streamHead" } }, "/videos/{id}": { "patch": { "x-controller-name": "VideoStudioController", "x-operation-name": "patch", "tags": [ "VideoStudioController" ], "responses": { "200": { "description": "The updated video", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchVideoRequest" } } }, "x-parameter-index": 1 }, "operationId": "VideoStudioController.patch" }, "get": { "x-controller-name": "VideoStudioController", "x-operation-name": "detail", "tags": [ "VideoStudioController" ], "responses": { "200": { "description": "A video with its takes, script summaries, and credit total", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VideoStudioController.detail" } }, "/videos": { "post": { "x-controller-name": "VideoStudioController", "x-operation-name": "create", "tags": [ "VideoStudioController" ], "responses": { "200": { "description": "The newly created draft video", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVideoRequest" } } } }, "operationId": "VideoStudioController.create" }, "get": { "x-controller-name": "VideoStudioController", "x-operation-name": "list", "tags": [ "VideoStudioController" ], "responses": { "200": { "description": "Videos, newest first, filterable by status and archived", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "Filter by pipeline status (draft, concept, …). Unknown values 422." }, { "name": "archived", "in": "query", "schema": { "type": "boolean" }, "description": "Filter by archived flag. Omitted → only non-archived rows are returned." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "description": "How many to return (default 20, max 50); clamped, never rejected." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip for pagination (default 0)." } ], "operationId": "VideoStudioController.list" } }, "/virtual-company-mandate-assignments": { "get": { "x-controller-name": "CompanyMandateAssignmentController", "x-operation-name": "getVirtual", "tags": [ "CompanyMandateAssignmentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "filter", "in": "query", "schema": { "type": "string" } } ], "operationId": "CompanyMandateAssignmentController.getVirtual" } }, "/webhook-converted-leads/pending-owner/count": { "get": { "x-controller-name": "WebhookLeadOwnerController", "x-operation-name": "pendingOwnerCount", "tags": [ "WebhookLeadOwnerController" ], "responses": { "200": { "description": "Count of webhook-converted leads awaiting an owner (for the review badge)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "WebhookLeadOwnerController.pendingOwnerCount" } }, "/webhook-converted-leads/pending-owner": { "get": { "x-controller-name": "WebhookLeadOwnerController", "x-operation-name": "pendingOwner", "tags": [ "WebhookLeadOwnerController" ], "responses": { "200": { "description": "Webhook-converted leads whose company has no owner login yet (super-user review queue)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "operationId": "WebhookLeadOwnerController.pendingOwner" } }, "/webhook-converted-leads/{prospectId}/provision-owner": { "post": { "x-controller-name": "WebhookLeadOwnerController", "x-operation-name": "provisionOwner", "tags": [ "WebhookLeadOwnerController" ], "responses": { "200": { "description": "Provision the invited, password-less owner login for a webhook-converted lead and send the welcome email", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "prospectId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "WebhookLeadOwnerController.provisionOwner" } }, "/webhooks/resend": { "post": { "x-controller-name": "ResendWebhookController", "x-operation-name": "handle", "tags": [ "ResendWebhookController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Event acknowledged" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ResendWebhookController.handle" } }, "/welcome-emails/sample-previews": { "get": { "x-controller-name": "WelcomeEmailSamplesController", "x-operation-name": "samplePreviews", "tags": [ "WelcomeEmailSamplesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Rendered previews for every welcome-email variant × hasPassword × isMarketingPartner combination" } } } } }, "operationId": "WelcomeEmailSamplesController.samplePreviews" } }, "/welcome-emails/send-test": { "post": { "x-controller-name": "WelcomeEmailSamplesController", "x-operation-name": "sendTest", "tags": [ "WelcomeEmailSamplesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Result of sending one welcome-email variant as a test" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "variant" ], "properties": { "variant": { "type": "string" }, "hasPassword": { "type": "boolean" }, "isMarketingPartner": { "type": "boolean" }, "to": { "type": "string", "nullable": true } } } } } }, "operationId": "WelcomeEmailSamplesController.sendTest" } }, "/wellness-censuses/count": { "get": { "x-controller-name": "WellnessCensusController", "x-operation-name": "count", "tags": [ "WellnessCensusController" ], "responses": { "200": { "description": "WellnessCensus model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "WellnessCensus.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "WellnessCensusController.count" } }, "/wellness-censuses/{id}": { "put": { "x-controller-name": "WellnessCensusController", "x-operation-name": "replaceById", "tags": [ "WellnessCensusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "WellnessCensus PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessCensus" } } }, "x-parameter-index": 1 }, "operationId": "WellnessCensusController.replaceById" }, "patch": { "x-controller-name": "WellnessCensusController", "x-operation-name": "updateById", "tags": [ "WellnessCensusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "WellnessCensus PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessCensusPartial" } } }, "x-parameter-index": 1 }, "operationId": "WellnessCensusController.updateById" }, "get": { "x-controller-name": "WellnessCensusController", "x-operation-name": "findById", "tags": [ "WellnessCensusController" ], "responses": { "200": { "description": "WellnessCensus model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessCensusWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessCensus.Filter" } } } } ], "operationId": "WellnessCensusController.findById" }, "delete": { "x-controller-name": "WellnessCensusController", "x-operation-name": "deleteById", "tags": [ "WellnessCensusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "WellnessCensus DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "WellnessCensusController.deleteById" } }, "/wellness-censuses": { "post": { "x-controller-name": "WellnessCensusController", "x-operation-name": "create", "tags": [ "WellnessCensusController" ], "responses": { "200": { "description": "WellnessCensus model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessCensus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewWellnessCensus" } } } }, "operationId": "WellnessCensusController.create" }, "patch": { "x-controller-name": "WellnessCensusController", "x-operation-name": "updateAll", "tags": [ "WellnessCensusController" ], "responses": { "200": { "description": "WellnessCensus PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "WellnessCensus.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessCensusPartial" } } } }, "operationId": "WellnessCensusController.updateAll" }, "get": { "x-controller-name": "WellnessCensusController", "x-operation-name": "find", "tags": [ "WellnessCensusController" ], "responses": { "200": { "description": "Array of WellnessCensus model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WellnessCensusWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessCensus.Filter1" } } } } ], "operationId": "WellnessCensusController.find" } }, "/wellness-quotes/count": { "get": { "x-controller-name": "WellnessQuoteController", "x-operation-name": "count", "tags": [ "WellnessQuoteController" ], "responses": { "200": { "description": "WellnessQuote model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "WellnessQuote.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "WellnessQuoteController.count" } }, "/wellness-quotes/{id}": { "put": { "x-controller-name": "WellnessQuoteController", "x-operation-name": "replaceById", "tags": [ "WellnessQuoteController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "WellnessQuote PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessQuote" } } }, "x-parameter-index": 1 }, "operationId": "WellnessQuoteController.replaceById" }, "patch": { "x-controller-name": "WellnessQuoteController", "x-operation-name": "updateById", "tags": [ "WellnessQuoteController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "WellnessQuote PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessQuotePartial" } } }, "x-parameter-index": 1 }, "operationId": "WellnessQuoteController.updateById" }, "get": { "x-controller-name": "WellnessQuoteController", "x-operation-name": "findById", "tags": [ "WellnessQuoteController" ], "responses": { "200": { "description": "WellnessQuote model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessQuoteWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessQuote.Filter" } } } } ], "operationId": "WellnessQuoteController.findById" }, "delete": { "x-controller-name": "WellnessQuoteController", "x-operation-name": "deleteById", "tags": [ "WellnessQuoteController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "WellnessQuote DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "WellnessQuoteController.deleteById" } }, "/wellness-quotes": { "post": { "x-controller-name": "WellnessQuoteController", "x-operation-name": "create", "tags": [ "WellnessQuoteController" ], "responses": { "200": { "description": "WellnessQuote model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessQuote" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewWellnessQuote" } } } }, "operationId": "WellnessQuoteController.create" }, "patch": { "x-controller-name": "WellnessQuoteController", "x-operation-name": "updateAll", "tags": [ "WellnessQuoteController" ], "responses": { "200": { "description": "WellnessQuote PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "WellnessQuote.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessQuotePartial" } } } }, "operationId": "WellnessQuoteController.updateAll" }, "get": { "x-controller-name": "WellnessQuoteController", "x-operation-name": "find", "tags": [ "WellnessQuoteController" ], "responses": { "200": { "description": "Array of WellnessQuote model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WellnessQuoteWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessQuote.Filter1" } } } } ], "operationId": "WellnessQuoteController.find" } }, "/wellness-short-censuses/count": { "get": { "x-controller-name": "WellnessShortCensusController", "x-operation-name": "count", "tags": [ "WellnessShortCensusController" ], "responses": { "200": { "description": "WellnessShortCensus model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "WellnessShortCensus.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "WellnessShortCensusController.count" } }, "/wellness-short-censuses/{id}": { "put": { "x-controller-name": "WellnessShortCensusController", "x-operation-name": "replaceById", "tags": [ "WellnessShortCensusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "WellnessShortCensus PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessShortCensus" } } }, "x-parameter-index": 1 }, "operationId": "WellnessShortCensusController.replaceById" }, "patch": { "x-controller-name": "WellnessShortCensusController", "x-operation-name": "updateById", "tags": [ "WellnessShortCensusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "WellnessShortCensus PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessShortCensusPartial" } } }, "x-parameter-index": 1 }, "operationId": "WellnessShortCensusController.updateById" }, "get": { "x-controller-name": "WellnessShortCensusController", "x-operation-name": "findById", "tags": [ "WellnessShortCensusController" ], "responses": { "200": { "description": "WellnessShortCensus model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessShortCensusWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessShortCensus.Filter" } } } } ], "operationId": "WellnessShortCensusController.findById" }, "delete": { "x-controller-name": "WellnessShortCensusController", "x-operation-name": "deleteById", "tags": [ "WellnessShortCensusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "WellnessShortCensus DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "WellnessShortCensusController.deleteById" } }, "/wellness-short-censuses": { "post": { "x-controller-name": "WellnessShortCensusController", "x-operation-name": "create", "tags": [ "WellnessShortCensusController" ], "responses": { "200": { "description": "WellnessShortCensus model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessShortCensus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewWellnessShortCensus" } } } }, "operationId": "WellnessShortCensusController.create" }, "patch": { "x-controller-name": "WellnessShortCensusController", "x-operation-name": "updateAll", "tags": [ "WellnessShortCensusController" ], "responses": { "200": { "description": "WellnessShortCensus PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "WellnessShortCensus.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessShortCensusPartial" } } } }, "operationId": "WellnessShortCensusController.updateAll" }, "get": { "x-controller-name": "WellnessShortCensusController", "x-operation-name": "find", "tags": [ "WellnessShortCensusController" ], "responses": { "200": { "description": "Array of WellnessShortCensus model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WellnessShortCensusWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellnessShortCensus.Filter1" } } } } ], "operationId": "WellnessShortCensusController.find" } }, "/whoAmI": { "get": { "x-controller-name": "ClearErcUsersController", "x-operation-name": "whoAmI", "tags": [ "ClearErcUsersController" ], "responses": { "200": { "description": "Who Am I", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "operationId": "ClearErcUsersController.whoAmI" } }, "/word": { "get": { "x-controller-name": "WordDocumentController", "x-operation-name": "word", "tags": [ "WordDocumentController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "processflowID", "in": "query", "schema": { "type": "string" } }, { "name": "helpDocs", "in": "query", "schema": { "type": "string" } } ], "operationId": "WordDocumentController.word" } }, "/zip-codes/count": { "get": { "x-controller-name": "ZipCodesController", "x-operation-name": "count", "tags": [ "ZipCodesController" ], "responses": { "200": { "description": "ZipCodes model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ZipCodes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ZipCodesController.count" } }, "/zip-codes/{id}": { "put": { "x-controller-name": "ZipCodesController", "x-operation-name": "replaceById", "tags": [ "ZipCodesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ZipCodes PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes" } } }, "x-parameter-index": 1 }, "operationId": "ZipCodesController.replaceById" }, "patch": { "x-controller-name": "ZipCodesController", "x-operation-name": "updateById", "tags": [ "ZipCodesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ZipCodes PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ZipCodesController.updateById" }, "get": { "x-controller-name": "ZipCodesController", "x-operation-name": "findById", "tags": [ "ZipCodesController" ], "responses": { "200": { "description": "ZipCodes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes.Filter" } } } } ], "operationId": "ZipCodesController.findById" }, "delete": { "x-controller-name": "ZipCodesController", "x-operation-name": "deleteById", "tags": [ "ZipCodesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ZipCodes DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ZipCodesController.deleteById" } }, "/zip-codes": { "post": { "x-controller-name": "ZipCodesController", "x-operation-name": "create", "tags": [ "ZipCodesController" ], "responses": { "200": { "description": "ZipCodes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewZipCodes" } } } }, "operationId": "ZipCodesController.create" }, "patch": { "x-controller-name": "ZipCodesController", "x-operation-name": "updateAll", "tags": [ "ZipCodesController" ], "responses": { "200": { "description": "ZipCodes PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ZipCodes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodesPartial" } } } }, "operationId": "ZipCodesController.updateAll" }, "get": { "x-controller-name": "ZipCodesController", "x-operation-name": "find", "tags": [ "ZipCodesController" ], "responses": { "200": { "description": "Array of ZipCodes model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ZipCodesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes.Filter1" } } } } ], "operationId": "ZipCodesController.find" } }, "/": { "get": { "x-controller-name": "HomePageController", "x-operation-name": "homePage", "tags": [ "HomePageController" ], "responses": { "200": { "description": "Home Page", "content": { "text/html": { "schema": { "type": "string" } } } } }, "operationId": "HomePageController.homePage" } } }, "servers": [ { "url": "https://api.staging.ercrepair.com" } ], "components": { "schemas": { "ZipCodes": { "title": "ZipCodes", "type": "object", "properties": { "city": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "lat": { "type": "string", "nullable": true }, "long": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewZipCodes": { "title": "NewZipCodes", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewZipCodes', exclude: [ 'id' ] })", "properties": { "city": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "lat": { "type": "string", "nullable": true }, "long": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ZipCodesWithRelations": { "title": "ZipCodesWithRelations", "type": "object", "description": "(tsType: ZipCodesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "city": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "lat": { "type": "string", "nullable": true }, "long": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "ZipCodesWithRelations" }, "ZipCodesPartial": { "title": "ZipCodesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "city": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "lat": { "type": "string", "nullable": true }, "long": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "WellnessShortCensus": { "title": "WellnessShortCensus", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": false }, "lastName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "stateEmployeeFilesIn": { "type": "string", "nullable": true }, "paySchedule": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": true }, "employeeContributionMajorMedicalTotalPp": { "type": "number", "nullable": true }, "federal2020W4Used": { "type": "string", "nullable": true }, "federalMaritalFilingStatus": { "type": "string", "nullable": true }, "federalExemptionsClaimed": { "type": "number", "nullable": true }, "stateMaritalFilingStatus": { "type": "string", "nullable": true }, "hireDate": { "type": "string", "format": "date-time", "nullable": true }, "stateExemptionsClaimed": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewWellnessShortCensus": { "title": "NewWellnessShortCensus", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewWellnessShortCensus', exclude: [ 'id' ] })", "properties": { "companyId": { "type": "number", "nullable": false }, "lastName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "stateEmployeeFilesIn": { "type": "string", "nullable": true }, "paySchedule": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": true }, "employeeContributionMajorMedicalTotalPp": { "type": "number", "nullable": true }, "federal2020W4Used": { "type": "string", "nullable": true }, "federalMaritalFilingStatus": { "type": "string", "nullable": true }, "federalExemptionsClaimed": { "type": "number", "nullable": true }, "stateMaritalFilingStatus": { "type": "string", "nullable": true }, "hireDate": { "type": "string", "format": "date-time", "nullable": true }, "stateExemptionsClaimed": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "WellnessShortCensusWithRelations": { "title": "WellnessShortCensusWithRelations", "type": "object", "description": "(tsType: WellnessShortCensusWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": false }, "lastName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "stateEmployeeFilesIn": { "type": "string", "nullable": true }, "paySchedule": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": true }, "employeeContributionMajorMedicalTotalPp": { "type": "number", "nullable": true }, "federal2020W4Used": { "type": "string", "nullable": true }, "federalMaritalFilingStatus": { "type": "string", "nullable": true }, "federalExemptionsClaimed": { "type": "number", "nullable": true }, "stateMaritalFilingStatus": { "type": "string", "nullable": true }, "hireDate": { "type": "string", "format": "date-time", "nullable": true }, "stateExemptionsClaimed": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "WellnessShortCensusWithRelations" }, "WellnessShortCensusPartial": { "title": "WellnessShortCensusPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": false }, "lastName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "stateEmployeeFilesIn": { "type": "string", "nullable": true }, "paySchedule": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": true }, "employeeContributionMajorMedicalTotalPp": { "type": "number", "nullable": true }, "federal2020W4Used": { "type": "string", "nullable": true }, "federalMaritalFilingStatus": { "type": "string", "nullable": true }, "federalExemptionsClaimed": { "type": "number", "nullable": true }, "stateMaritalFilingStatus": { "type": "string", "nullable": true }, "hireDate": { "type": "string", "format": "date-time", "nullable": true }, "stateExemptionsClaimed": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "WellnessQuote": { "title": "WellnessQuote", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "filingStatus": { "type": "string", "nullable": true }, "exemptionsClaimed": { "type": "number", "nullable": true }, "paySchedule": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": true }, "employeeSavingsPerPayPeriod": { "type": "number", "nullable": true }, "employeeSavingsMonthly": { "type": "number", "nullable": true }, "annualEmployerSavings": { "type": "number", "nullable": true }, "wellnessEmployeeId": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewWellnessQuote": { "title": "NewWellnessQuote", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewWellnessQuote', exclude: [ 'id' ] })", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "filingStatus": { "type": "string", "nullable": true }, "exemptionsClaimed": { "type": "number", "nullable": true }, "paySchedule": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": true }, "employeeSavingsPerPayPeriod": { "type": "number", "nullable": true }, "employeeSavingsMonthly": { "type": "number", "nullable": true }, "annualEmployerSavings": { "type": "number", "nullable": true }, "wellnessEmployeeId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "WellnessQuoteWithRelations": { "title": "WellnessQuoteWithRelations", "type": "object", "description": "(tsType: WellnessQuoteWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "filingStatus": { "type": "string", "nullable": true }, "exemptionsClaimed": { "type": "number", "nullable": true }, "paySchedule": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": true }, "employeeSavingsPerPayPeriod": { "type": "number", "nullable": true }, "employeeSavingsMonthly": { "type": "number", "nullable": true }, "annualEmployerSavings": { "type": "number", "nullable": true }, "wellnessEmployeeId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "WellnessQuoteWithRelations" }, "WellnessQuotePartial": { "title": "WellnessQuotePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "filingStatus": { "type": "string", "nullable": true }, "exemptionsClaimed": { "type": "number", "nullable": true }, "paySchedule": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": true }, "employeeSavingsPerPayPeriod": { "type": "number", "nullable": true }, "employeeSavingsMonthly": { "type": "number", "nullable": true }, "annualEmployerSavings": { "type": "number", "nullable": true }, "wellnessEmployeeId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "WellnessCensus": { "title": "WellnessCensus", "type": "object", "properties": { "f_2020W4Box2cTwoJobs": { "type": "string", "nullable": true }, "f_2020W4FederalDependentsAmount": { "type": "number", "nullable": true }, "f_401kContributionTotalPp": { "type": "number", "nullable": true }, "additionalPreTaxDeductionsTotalPp": { "type": "number", "nullable": true }, "businessPhone": { "type": "string", "nullable": true }, "carrier": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "companyDepartment": { "type": "string", "nullable": true }, "companyDepartmentCode": { "type": "string", "nullable": true }, "dob": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "email": { "type": "string", "nullable": true }, "employeeContributionMajorMedicalTotalPp": { "type": "string", "nullable": false }, "employeeUsername": { "type": "string", "nullable": true }, "employerLocationDivision": { "type": "string", "nullable": true }, "exemptFromSs": { "type": "string", "nullable": true }, "exemptionAmountClaimed": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "federal_2020W4Used": { "type": "string", "nullable": false }, "federalExemptionsClaimed": { "type": "number", "nullable": false }, "federalMaritalFilingStatus": { "type": "string", "nullable": false }, "firstName": { "type": "string", "nullable": false }, "gender": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": false }, "groupName": { "type": "string", "nullable": true }, "hireDate": { "type": "string", "format": "date-time", "nullable": true }, "homePhone": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "lastName": { "type": "string", "nullable": false }, "medicalTier": { "type": "string", "nullable": true }, "paySchedule": { "type": "string", "nullable": false }, "postTaxDeductionsTotalPp": { "type": "number", "nullable": true }, "prAllowancesBasedOnDeductions": { "type": "number", "nullable": true }, "prNonResident": { "type": "string", "nullable": true }, "prVeteranExemption": { "type": "string", "nullable": true }, "prYoungAdult": { "type": "string", "nullable": true }, "relationshipStatus": { "type": "string", "nullable": true }, "spouseWorks": { "type": "string", "nullable": true }, "ssn": { "type": "string", "nullable": false }, "stateDependentExemptionsClaimed": { "type": "number", "nullable": true }, "stateEmployeeFilesIn": { "type": "string", "nullable": false }, "stateExemptionsClaimed": { "type": "number", "nullable": false }, "stateMaritalFilingStatus": { "type": "string", "nullable": false }, "stateOfResidence": { "type": "string", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "streetAddress_2": { "type": "string", "nullable": true }, "subscriberId": { "type": "string", "nullable": true }, "witholdingRate": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "dateAdded": { "type": "string", "format": "date-time", "nullable": true }, "zip": { "type": "string", "nullable": true } }, "required": [ "employeeContributionMajorMedicalTotalPp", "federal_2020W4Used", "federalExemptionsClaimed", "federalMaritalFilingStatus", "firstName", "grossWagesPerPayPeriod", "lastName", "paySchedule", "ssn", "stateEmployeeFilesIn", "stateExemptionsClaimed", "stateMaritalFilingStatus" ], "additionalProperties": false }, "NewWellnessCensus": { "title": "NewWellnessCensus", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewWellnessCensus', exclude: [ 'id' ] })", "properties": { "f_2020W4Box2cTwoJobs": { "type": "string", "nullable": true }, "f_2020W4FederalDependentsAmount": { "type": "number", "nullable": true }, "f_401kContributionTotalPp": { "type": "number", "nullable": true }, "additionalPreTaxDeductionsTotalPp": { "type": "number", "nullable": true }, "businessPhone": { "type": "string", "nullable": true }, "carrier": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "companyDepartment": { "type": "string", "nullable": true }, "companyDepartmentCode": { "type": "string", "nullable": true }, "dob": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "email": { "type": "string", "nullable": true }, "employeeContributionMajorMedicalTotalPp": { "type": "string", "nullable": false }, "employeeUsername": { "type": "string", "nullable": true }, "employerLocationDivision": { "type": "string", "nullable": true }, "exemptFromSs": { "type": "string", "nullable": true }, "exemptionAmountClaimed": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "federal_2020W4Used": { "type": "string", "nullable": false }, "federalExemptionsClaimed": { "type": "number", "nullable": false }, "federalMaritalFilingStatus": { "type": "string", "nullable": false }, "firstName": { "type": "string", "nullable": false }, "gender": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": false }, "groupName": { "type": "string", "nullable": true }, "hireDate": { "type": "string", "format": "date-time", "nullable": true }, "homePhone": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": false }, "medicalTier": { "type": "string", "nullable": true }, "paySchedule": { "type": "string", "nullable": false }, "postTaxDeductionsTotalPp": { "type": "number", "nullable": true }, "prAllowancesBasedOnDeductions": { "type": "number", "nullable": true }, "prNonResident": { "type": "string", "nullable": true }, "prVeteranExemption": { "type": "string", "nullable": true }, "prYoungAdult": { "type": "string", "nullable": true }, "relationshipStatus": { "type": "string", "nullable": true }, "spouseWorks": { "type": "string", "nullable": true }, "ssn": { "type": "string", "nullable": false }, "stateDependentExemptionsClaimed": { "type": "number", "nullable": true }, "stateEmployeeFilesIn": { "type": "string", "nullable": false }, "stateExemptionsClaimed": { "type": "number", "nullable": false }, "stateMaritalFilingStatus": { "type": "string", "nullable": false }, "stateOfResidence": { "type": "string", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "streetAddress_2": { "type": "string", "nullable": true }, "subscriberId": { "type": "string", "nullable": true }, "witholdingRate": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "dateAdded": { "type": "string", "format": "date-time", "nullable": true }, "zip": { "type": "string", "nullable": true } }, "required": [ "employeeContributionMajorMedicalTotalPp", "federal_2020W4Used", "federalExemptionsClaimed", "federalMaritalFilingStatus", "firstName", "grossWagesPerPayPeriod", "lastName", "paySchedule", "ssn", "stateEmployeeFilesIn", "stateExemptionsClaimed", "stateMaritalFilingStatus" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "WellnessCensusWithRelations": { "title": "WellnessCensusWithRelations", "type": "object", "description": "(tsType: WellnessCensusWithRelations, schemaOptions: { includeRelations: true })", "properties": { "f_2020W4Box2cTwoJobs": { "type": "string", "nullable": true }, "f_2020W4FederalDependentsAmount": { "type": "number", "nullable": true }, "f_401kContributionTotalPp": { "type": "number", "nullable": true }, "additionalPreTaxDeductionsTotalPp": { "type": "number", "nullable": true }, "businessPhone": { "type": "string", "nullable": true }, "carrier": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "companyDepartment": { "type": "string", "nullable": true }, "companyDepartmentCode": { "type": "string", "nullable": true }, "dob": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "email": { "type": "string", "nullable": true }, "employeeContributionMajorMedicalTotalPp": { "type": "string", "nullable": false }, "employeeUsername": { "type": "string", "nullable": true }, "employerLocationDivision": { "type": "string", "nullable": true }, "exemptFromSs": { "type": "string", "nullable": true }, "exemptionAmountClaimed": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "federal_2020W4Used": { "type": "string", "nullable": false }, "federalExemptionsClaimed": { "type": "number", "nullable": false }, "federalMaritalFilingStatus": { "type": "string", "nullable": false }, "firstName": { "type": "string", "nullable": false }, "gender": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": false }, "groupName": { "type": "string", "nullable": true }, "hireDate": { "type": "string", "format": "date-time", "nullable": true }, "homePhone": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "lastName": { "type": "string", "nullable": false }, "medicalTier": { "type": "string", "nullable": true }, "paySchedule": { "type": "string", "nullable": false }, "postTaxDeductionsTotalPp": { "type": "number", "nullable": true }, "prAllowancesBasedOnDeductions": { "type": "number", "nullable": true }, "prNonResident": { "type": "string", "nullable": true }, "prVeteranExemption": { "type": "string", "nullable": true }, "prYoungAdult": { "type": "string", "nullable": true }, "relationshipStatus": { "type": "string", "nullable": true }, "spouseWorks": { "type": "string", "nullable": true }, "ssn": { "type": "string", "nullable": false }, "stateDependentExemptionsClaimed": { "type": "number", "nullable": true }, "stateEmployeeFilesIn": { "type": "string", "nullable": false }, "stateExemptionsClaimed": { "type": "number", "nullable": false }, "stateMaritalFilingStatus": { "type": "string", "nullable": false }, "stateOfResidence": { "type": "string", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "streetAddress_2": { "type": "string", "nullable": true }, "subscriberId": { "type": "string", "nullable": true }, "witholdingRate": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "dateAdded": { "type": "string", "format": "date-time", "nullable": true }, "zip": { "type": "string", "nullable": true } }, "required": [ "employeeContributionMajorMedicalTotalPp", "federal_2020W4Used", "federalExemptionsClaimed", "federalMaritalFilingStatus", "firstName", "grossWagesPerPayPeriod", "lastName", "paySchedule", "ssn", "stateEmployeeFilesIn", "stateExemptionsClaimed", "stateMaritalFilingStatus" ], "additionalProperties": false, "x-typescript-type": "WellnessCensusWithRelations" }, "WellnessCensusPartial": { "title": "WellnessCensusPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "f_2020W4Box2cTwoJobs": { "type": "string", "nullable": true }, "f_2020W4FederalDependentsAmount": { "type": "number", "nullable": true }, "f_401kContributionTotalPp": { "type": "number", "nullable": true }, "additionalPreTaxDeductionsTotalPp": { "type": "number", "nullable": true }, "businessPhone": { "type": "string", "nullable": true }, "carrier": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "companyDepartment": { "type": "string", "nullable": true }, "companyDepartmentCode": { "type": "string", "nullable": true }, "dob": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "email": { "type": "string", "nullable": true }, "employeeContributionMajorMedicalTotalPp": { "type": "string", "nullable": false }, "employeeUsername": { "type": "string", "nullable": true }, "employerLocationDivision": { "type": "string", "nullable": true }, "exemptFromSs": { "type": "string", "nullable": true }, "exemptionAmountClaimed": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "federal_2020W4Used": { "type": "string", "nullable": false }, "federalExemptionsClaimed": { "type": "number", "nullable": false }, "federalMaritalFilingStatus": { "type": "string", "nullable": false }, "firstName": { "type": "string", "nullable": false }, "gender": { "type": "string", "nullable": true }, "grossWagesPerPayPeriod": { "type": "number", "nullable": false }, "groupName": { "type": "string", "nullable": true }, "hireDate": { "type": "string", "format": "date-time", "nullable": true }, "homePhone": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "lastName": { "type": "string", "nullable": false }, "medicalTier": { "type": "string", "nullable": true }, "paySchedule": { "type": "string", "nullable": false }, "postTaxDeductionsTotalPp": { "type": "number", "nullable": true }, "prAllowancesBasedOnDeductions": { "type": "number", "nullable": true }, "prNonResident": { "type": "string", "nullable": true }, "prVeteranExemption": { "type": "string", "nullable": true }, "prYoungAdult": { "type": "string", "nullable": true }, "relationshipStatus": { "type": "string", "nullable": true }, "spouseWorks": { "type": "string", "nullable": true }, "ssn": { "type": "string", "nullable": false }, "stateDependentExemptionsClaimed": { "type": "number", "nullable": true }, "stateEmployeeFilesIn": { "type": "string", "nullable": false }, "stateExemptionsClaimed": { "type": "number", "nullable": false }, "stateMaritalFilingStatus": { "type": "string", "nullable": false }, "stateOfResidence": { "type": "string", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "streetAddress_2": { "type": "string", "nullable": true }, "subscriberId": { "type": "string", "nullable": true }, "witholdingRate": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "dateAdded": { "type": "string", "format": "date-time", "nullable": true }, "zip": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "UtmLog": { "title": "UtmLog", "type": "object", "properties": { "id": { "type": "number" }, "eventDatetime": { "type": "string", "format": "date-time" }, "utm": { "type": "string" }, "site": { "type": "string" }, "userId": { "type": "string" }, "ipAddress": { "type": "string" }, "notes": { "type": "string" }, "data": { "type": "string" } }, "additionalProperties": false }, "NewUtmLog": { "title": "NewUtmLog", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewUtmLog', exclude: [ 'id' ] })", "properties": { "eventDatetime": { "type": "string", "format": "date-time" }, "utm": { "type": "string" }, "site": { "type": "string" }, "userId": { "type": "string" }, "ipAddress": { "type": "string" }, "notes": { "type": "string" }, "data": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UtmLogWithRelations": { "title": "UtmLogWithRelations", "type": "object", "description": "(tsType: UtmLogWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "eventDatetime": { "type": "string", "format": "date-time" }, "utm": { "type": "string" }, "site": { "type": "string" }, "userId": { "type": "string" }, "ipAddress": { "type": "string" }, "notes": { "type": "string" }, "data": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "UtmLogWithRelations" }, "UtmLogPartial": { "title": "UtmLogPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "eventDatetime": { "type": "string", "format": "date-time" }, "utm": { "type": "string" }, "site": { "type": "string" }, "userId": { "type": "string" }, "ipAddress": { "type": "string" }, "notes": { "type": "string" }, "data": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "UtmLinks": { "title": "UtmLinks", "type": "object", "properties": { "id": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "lastEntityAdded": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "source": { "type": "string" }, "medium": { "type": "string" }, "campaign": { "type": "string" }, "term": { "type": "string" }, "content": { "type": "string" }, "notes": { "type": "string" }, "owner": { "type": "string" } }, "additionalProperties": false }, "NewUtmLinks": { "title": "NewUtmLinks", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewUtmLinks', exclude: [ 'id' ] })", "properties": { "lastUpdated": { "type": "string", "format": "date-time" }, "lastEntityAdded": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "source": { "type": "string" }, "medium": { "type": "string" }, "campaign": { "type": "string" }, "term": { "type": "string" }, "content": { "type": "string" }, "notes": { "type": "string" }, "owner": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UtmLinksWithRelations": { "title": "UtmLinksWithRelations", "type": "object", "description": "(tsType: UtmLinksWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "lastEntityAdded": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "source": { "type": "string" }, "medium": { "type": "string" }, "campaign": { "type": "string" }, "term": { "type": "string" }, "content": { "type": "string" }, "notes": { "type": "string" }, "owner": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "UtmLinksWithRelations" }, "UtmLinksPartial": { "title": "UtmLinksPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "lastEntityAdded": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "source": { "type": "string" }, "medium": { "type": "string" }, "campaign": { "type": "string" }, "term": { "type": "string" }, "content": { "type": "string" }, "notes": { "type": "string" }, "owner": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Roles": { "title": "Roles", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "roleCode": { "type": "string" } }, "additionalProperties": false }, "NewRolesInUser": { "title": "NewRolesInUser", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRolesInUser', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "roleCode": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "RolesPartial": { "title": "RolesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "roleCode": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "UserLevel": { "title": "UserLevel", "type": "object", "properties": { "id": { "type": "number" }, "slug": { "type": "string" }, "name": { "type": "string" }, "roleGroupId": { "type": "number" }, "companyType": { "type": "string" }, "resolveVia": { "type": "string" }, "sortOrder": { "type": "number" } }, "additionalProperties": false }, "NewUserLevel": { "title": "NewUserLevel", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewUserLevel', exclude: [ 'id' ] })", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "roleGroupId": { "type": "number" }, "companyType": { "type": "string" }, "resolveVia": { "type": "string" }, "sortOrder": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UserLevelWithRelations": { "title": "UserLevelWithRelations", "type": "object", "description": "(tsType: UserLevelWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "slug": { "type": "string" }, "name": { "type": "string" }, "roleGroupId": { "type": "number" }, "companyType": { "type": "string" }, "resolveVia": { "type": "string" }, "sortOrder": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "UserLevelWithRelations" }, "UserLevelPartial": { "title": "UserLevelPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "slug": { "type": "string" }, "name": { "type": "string" }, "roleGroupId": { "type": "number" }, "companyType": { "type": "string" }, "resolveVia": { "type": "string" }, "sortOrder": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "UserCompany": { "title": "UserCompany", "type": "object", "properties": { "commissionPercentage": { "type": "number" }, "id": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time" }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time" }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time" }, "inviteDispatchedAt": { "type": "string", "format": "date-time" }, "ercUserId": { "type": "string" }, "companyId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false }, "NewUserCompany": { "title": "NewUserCompany", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewUserCompany', exclude: [ 'id' ] })", "properties": { "commissionPercentage": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time" }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time" }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time" }, "inviteDispatchedAt": { "type": "string", "format": "date-time" }, "ercUserId": { "type": "string" }, "companyId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "Company": { "title": "Company", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "expectedLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "goLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "address": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "bankAddress": { "type": "string" }, "bankCity": { "type": "string" }, "bankState": { "type": "string" }, "bankZipCode": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "createdByUserId": { "type": "string" }, "ownedById": { "type": "string" }, "referredByCompanyId": { "type": "number" }, "tenantHost": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "reviewerId": { "type": "string" }, "website": { "type": "string" }, "logoUrl": { "type": "string" }, "logoStatus": { "type": "string", "nullable": true }, "logoCandidateUrl": { "type": "string", "nullable": true }, "logoCandidateDomain": { "type": "string", "nullable": true }, "logoSource": { "type": "string", "nullable": true }, "logoEvidence": { "type": "string", "nullable": true }, "logoReviewedByUserId": { "type": "string", "nullable": true }, "logoReviewedAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "statusUpdatedAt": { "type": "string", "format": "date-time" }, "employerPhaseOverride": { "type": "string" }, "trainingCommsSentAt": { "type": "string", "format": "date-time", "nullable": true }, "employeeInvitesProvisionedAt": { "type": "string", "format": "date-time", "nullable": true }, "employerIntroSentAt": { "type": "string", "format": "date-time", "nullable": true }, "defaultFolder": { "type": "number" }, "ranking": { "type": "number" }, "qualifiedLives": { "type": "number" }, "isATest": { "type": "number" }, "groupMaster": { "type": "number" }, "finalRefundAmount": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "hedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "group": { "type": "number", "nullable": true }, "feeHedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "stripeCustomerId": { "type": "string" }, "qbCustomerId": { "type": "string" }, "routingNumber": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "accountHolderName": { "type": "string", "nullable": true }, "bankName": { "type": "string" }, "clientAddress": { "type": "string" }, "affiliateUserId": { "type": "string", "nullable": true }, "salesRepId": { "type": "string", "nullable": true }, "affiliateManagerId": { "type": "string", "nullable": true }, "payrollDataMethod": { "type": "string", "nullable": true }, "payrollDataStatus": { "type": "string", "nullable": true }, "payrollDataStatusNote": { "type": "string", "nullable": true }, "payrollDataStatusUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollDataStatusUpdatedById": { "type": "string", "nullable": true }, "payrollSubmissionCompleteAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollSubmissionCompleteById": { "type": "string", "nullable": true }, "payrollProviderId": { "type": "string", "nullable": true }, "usesPeo": { "type": "boolean", "nullable": true }, "subAffiliateUserId": { "type": "string", "nullable": true }, "einNumber": { "type": "string" }, "businessEntityType": { "type": "string", "nullable": true }, "stateOfIncorporation": { "type": "string", "nullable": true }, "subSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubSubAffiliateUserId": { "type": "string", "nullable": true }, "referrerUserId": { "type": "string", "nullable": true }, "language": { "type": "string" }, "companyType": { "type": "string" }, "livesCount": { "type": "number", "nullable": true }, "hedgeFundBuyoutCompanyId": { "type": "number" }, "feeHedgeFundBuyoutCompanyId": { "type": "number" }, "subAffiliateCommissionFee": { "type": "number", "nullable": true }, "affiliateCommissionTierOverrideId": { "type": "number", "nullable": true }, "charityCompanyId": { "type": "number", "nullable": true }, "processorCompanyId": { "type": "number", "nullable": true }, "affiliateHasBeenReviewed": { "type": "number", "nullable": true }, "affiliateWillPayDownlines": { "type": "number", "nullable": true }, "bypassContract": { "type": "number", "nullable": true }, "charityPayoutPerLife": { "type": "number" }, "isMarketingPartner": { "type": "boolean" }, "autoEnrollEmployees": { "type": "boolean" }, "calcomBookingUrl": { "type": "string" }, "affiliateCommissionSetValue": { "type": "number" }, "affiliateAmount": { "type": "number" }, "salesRepAmount": { "type": "number" }, "affiliateManagerAmount": { "type": "number" }, "subAffiliateAmount": { "type": "number" }, "subSubAffiliateAmount": { "type": "number" }, "subSubSubAffiliateAmount": { "type": "number" }, "grossWellnessFee": { "type": "number" }, "referrer1Id": { "type": "string", "nullable": true }, "referrer2Id": { "type": "string", "nullable": true }, "referrer3Id": { "type": "string", "nullable": true }, "referrer4Id": { "type": "string", "nullable": true }, "referrer5Id": { "type": "string", "nullable": true }, "referrer6Id": { "type": "string", "nullable": true }, "tariffsPaid": { "type": "string" }, "tariffsPaidToCountries": { "type": "string" }, "tariffIndustry": { "type": "string" }, "tariffEntryMethod": { "type": "string" }, "tariffComission1": { "type": "number" }, "tariffComission2": { "type": "number" }, "tariffComission1Sub": { "type": "number" }, "tariffComission2Sub": { "type": "number" }, "referrer1Amount": { "type": "number" }, "referrer2Amount": { "type": "number" }, "referrer3Amount": { "type": "number" }, "referrer4Amount": { "type": "number" }, "referrer5Amount": { "type": "number" }, "referrer6Amount": { "type": "number" }, "w2Employees": { "type": "number" }, "numberOfReferrers": { "type": "number" }, "enrolledW2Employees": { "type": "number" }, "estimatedTariffIncome": { "type": "number" }, "quotedTariffIncome": { "type": "number" }, "contractedTariffIncome": { "type": "number" }, "campaignFromEmail": { "type": "string" }, "campaignFromName": { "type": "string" }, "campaignReplyTo": { "type": "string" }, "dealState": { "type": "string", "nullable": true }, "dealLostReason": { "type": "string", "nullable": true }, "dealLostNote": { "type": "string", "nullable": true }, "dealLostAt": { "type": "string", "format": "date-time", "nullable": true }, "dealLostById": { "type": "string", "nullable": true }, "dealRevivedAt": { "type": "string", "format": "date-time", "nullable": true }, "dealRevivedById": { "type": "string", "nullable": true }, "dealTerminalRaisedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedById": { "type": "string", "nullable": true }, "employerGroupId": { "type": "number", "nullable": true } }, "additionalProperties": false }, "RoleGroups": { "title": "RoleGroups", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "owner": { "type": "number" }, "isPublic": { "type": "number" }, "isForCompany": { "type": "number" } }, "additionalProperties": false }, "UserCompanyWithRelations": { "title": "UserCompanyWithRelations", "type": "object", "description": "(tsType: UserCompanyWithRelations, schemaOptions: { includeRelations: true })", "properties": { "commissionPercentage": { "type": "number" }, "id": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time" }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time" }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time" }, "inviteDispatchedAt": { "type": "string", "format": "date-time" }, "ercUserId": { "type": "string" }, "companyId": { "type": "number" }, "roleGroupId": { "type": "number" }, "ercUser": { "$ref": "#/components/schemas/MarshalledUser" }, "foreignKey": {}, "company": { "$ref": "#/components/schemas/Company" }, "roleGroup": { "$ref": "#/components/schemas/RoleGroups" } }, "additionalProperties": false, "x-typescript-type": "UserCompanyWithRelations" }, "MarshalledUser": { "title": "MarshalledUser", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'MarshalledUser', exclude: [ 'password', 'verificationToken', 'stPass' ], includeRelations: false }), , , {\"indexInfo\":{\"email\":{\"unique\":false},\"username\":{\"username\":{\"unique\":true}},\"userKind\":{\"userKind\":{\"unique\":false}}}}", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "invitedAt": { "type": "string", "format": "date-time" }, "accountSetupAt": { "type": "string", "format": "date-time" }, "inviteSentAt": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string" }, "company": { "type": "number" }, "defaultProcessflowId": { "type": "number" }, "closerId": { "type": "string" }, "cpaUserId": { "type": "string" }, "accountManagerUserId": { "type": "string" }, "affiliateUserId": { "type": "string" }, "docCollectorId": { "type": "string" }, "affiliateDetails": { "type": "string" }, "taxAttorneyUserId": { "type": "string" }, "lastLoggedIn": { "type": "string", "format": "date-time" }, "isTempPassword": { "type": "boolean" }, "userStatus": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "utm": { "type": "string" }, "emailVerified": { "type": "boolean" }, "realm": { "type": "string" }, "stCompany": { "type": "number" }, "lastLoginHost": { "type": "string" }, "stUrl": { "type": "string" }, "passwordResetExpiresAt": { "type": "string", "format": "date-time" }, "pf7percentage": { "type": "number" }, "clientStatus": { "type": "number" }, "notificationConsentAt": { "type": "string", "format": "date-time" }, "termsVersionAccepted": { "type": "string" }, "notificationCategoryConsent": { "type": "string" }, "pushEnabled": { "type": "boolean" }, "notificationConsentIp": { "type": "string" }, "notificationConsentName": { "type": "string" }, "registrationIp": { "type": "string" }, "registrationLocation": { "type": "string" }, "smsOptedOut": { "type": "boolean" }, "smsOptedOutAt": { "type": "string", "format": "date-time" }, "smsSendTimezone": { "type": "string" }, "smsLastDigestAt": { "type": "string", "format": "date-time" }, "notificationDigestFrequency": { "type": "string", "enum": [ "daily", "weekly" ] }, "emailLastDigestAt": { "type": "string", "format": "date-time" }, "image": { "type": "string", "nullable": true }, "userKind": { "type": "string" }, "hasPassword": { "type": "boolean", "description": "Whether this account has a login password set at all. Derived from the (never-published) password hash — see accountHasPassword. False for accounts created without one (invite / magic-link / pre-signup wizard), which is what the \"set a password\" surface keys off." } }, "required": [ "email", "username" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "UserCompanyPartial": { "title": "UserCompanyPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "commissionPercentage": { "type": "number" }, "id": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time" }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time" }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time" }, "inviteDispatchedAt": { "type": "string", "format": "date-time" }, "ercUserId": { "type": "string" }, "companyId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "TransactionNew": { "title": "TransactionNew", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "sourceCompanyId": { "type": "number" }, "destinationCompanyId": { "type": "number" }, "sourceUserId": { "type": "string" }, "destinationUserId": { "type": "string" }, "clientCompanyId": { "type": "number" }, "role": { "type": "string", "enum": [ "affiliate", "sub_affiliate", "sub_sub_affiliate", "sub_sub_sub_affiliate", "sales_rep", "affiliate_manager", "referrer_1", "referrer_2", "referrer_3", "referrer_4", "referrer_5", "referrer_6", "none" ] }, "kind": { "type": "string", "enum": [ "commission", "referrer_fee", "tpa_receivable", "employer_charge", "adjustment", "fee" ] }, "amount": { "type": "number" }, "lives": { "type": "number" }, "amountPerLife": { "type": "number" }, "billingPeriodStart": { "type": "string", "format": "date-time" }, "billingPeriodEnd": { "type": "string", "format": "date-time" }, "occurredAt": { "type": "string", "format": "date-time" }, "tpaInvoiceId": { "type": "number" }, "state": { "type": "string", "enum": [ "open", "partially_paid", "paid", "reversed", "voided" ] }, "description": { "type": "string" }, "notes": { "type": "string" }, "legacySource": { "type": "string" }, "legacyId": { "type": "string" }, "importBatchId": { "type": "string" }, "sourceSnapshot": { "type": "object" } }, "required": [ "sourceCompanyId", "destinationCompanyId", "role", "kind", "amount", "occurredAt", "state" ], "additionalProperties": false }, "NewTransactionNew": { "title": "NewTransactionNew", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewTransactionNew', exclude: [ 'id', 'state', 'createdAt', 'updatedAt', 'createdById', 'legacySource', 'legacyId', 'importBatchId', 'sourceSnapshot' ] })", "properties": { "sourceCompanyId": { "type": "number" }, "destinationCompanyId": { "type": "number" }, "sourceUserId": { "type": "string" }, "destinationUserId": { "type": "string" }, "clientCompanyId": { "type": "number" }, "role": { "type": "string", "enum": [ "affiliate", "sub_affiliate", "sub_sub_affiliate", "sub_sub_sub_affiliate", "sales_rep", "affiliate_manager", "referrer_1", "referrer_2", "referrer_3", "referrer_4", "referrer_5", "referrer_6", "none" ] }, "kind": { "type": "string", "enum": [ "commission", "referrer_fee", "tpa_receivable", "employer_charge", "adjustment", "fee" ] }, "amount": { "type": "number" }, "lives": { "type": "number" }, "amountPerLife": { "type": "number" }, "billingPeriodStart": { "type": "string", "format": "date-time" }, "billingPeriodEnd": { "type": "string", "format": "date-time" }, "occurredAt": { "type": "string", "format": "date-time" }, "tpaInvoiceId": { "type": "number" }, "description": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "sourceCompanyId", "destinationCompanyId", "role", "kind", "amount", "occurredAt" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "TransactionNewWithRelations": { "title": "TransactionNewWithRelations", "type": "object", "description": "(tsType: TransactionNewWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "sourceCompanyId": { "type": "number" }, "destinationCompanyId": { "type": "number" }, "sourceUserId": { "type": "string" }, "destinationUserId": { "type": "string" }, "clientCompanyId": { "type": "number" }, "role": { "type": "string", "enum": [ "affiliate", "sub_affiliate", "sub_sub_affiliate", "sub_sub_sub_affiliate", "sales_rep", "affiliate_manager", "referrer_1", "referrer_2", "referrer_3", "referrer_4", "referrer_5", "referrer_6", "none" ] }, "kind": { "type": "string", "enum": [ "commission", "referrer_fee", "tpa_receivable", "employer_charge", "adjustment", "fee" ] }, "amount": { "type": "number" }, "lives": { "type": "number" }, "amountPerLife": { "type": "number" }, "billingPeriodStart": { "type": "string", "format": "date-time" }, "billingPeriodEnd": { "type": "string", "format": "date-time" }, "occurredAt": { "type": "string", "format": "date-time" }, "tpaInvoiceId": { "type": "number" }, "state": { "type": "string", "enum": [ "open", "partially_paid", "paid", "reversed", "voided" ] }, "description": { "type": "string" }, "notes": { "type": "string" }, "legacySource": { "type": "string" }, "legacyId": { "type": "string" }, "importBatchId": { "type": "string" }, "sourceSnapshot": { "type": "object" }, "sourceCompany": { "$ref": "#/components/schemas/Company" }, "foreignKey": {}, "destinationCompany": { "$ref": "#/components/schemas/Company" }, "clientCompany": { "$ref": "#/components/schemas/Company" } }, "required": [ "sourceCompanyId", "destinationCompanyId", "role", "kind", "amount", "occurredAt", "state" ], "additionalProperties": false, "x-typescript-type": "TransactionNewWithRelations" }, "BillingEvent": { "title": "BillingEvent", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "entityType": { "type": "string", "enum": [ "transaction_new", "payment_new", "allocation" ] }, "entityId": { "type": "string" }, "eventType": { "type": "string", "enum": [ "created", "allocated", "deallocated", "initiated", "sent", "confirmed", "returned", "voided", "reversed", "taken_over", "imported", "adjusted" ] }, "actorUserId": { "type": "string" }, "priorState": { "type": "object" }, "newState": { "type": "object" }, "reason": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "entityType", "entityId", "eventType" ], "additionalProperties": false }, "Transaction": { "title": "Transaction", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "paymentId": { "type": "string" }, "createdById": { "type": "string" }, "companyId": { "type": "number" }, "lineItemId": { "type": "number" }, "toCompanyId": { "type": "number" }, "fromCompanyId": { "type": "number" }, "toUserId": { "type": "string" }, "companyType": { "type": "string" }, "to": { "type": "string" }, "deletedBy": { "type": "string" }, "fromUserId": { "type": "string" }, "from": { "type": "string" }, "type": { "type": "string" }, "isDeleted": { "type": "boolean" }, "toUs": { "type": "boolean" }, "fromUs": { "type": "boolean" }, "amount": { "type": "number", "nullable": true }, "amountPerLife": { "type": "number", "nullable": true }, "lives": { "type": "number", "nullable": true }, "lineItemID": { "type": "number" }, "tpaInvoiceId": { "type": "number" }, "affiliateId": { "type": "number" }, "statusId": { "type": "number" }, "discountPercentage": { "type": "number" }, "notes": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false }, "NewTransaction": { "title": "NewTransaction", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewTransaction', exclude: [ 'id' ] })", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "paymentId": { "type": "string" }, "createdById": { "type": "string" }, "companyId": { "type": "number" }, "lineItemId": { "type": "number" }, "toCompanyId": { "type": "number" }, "fromCompanyId": { "type": "number" }, "toUserId": { "type": "string" }, "companyType": { "type": "string" }, "to": { "type": "string" }, "deletedBy": { "type": "string" }, "fromUserId": { "type": "string" }, "from": { "type": "string" }, "type": { "type": "string" }, "isDeleted": { "type": "boolean" }, "toUs": { "type": "boolean" }, "fromUs": { "type": "boolean" }, "amount": { "type": "number", "nullable": true }, "amountPerLife": { "type": "number", "nullable": true }, "lives": { "type": "number", "nullable": true }, "lineItemID": { "type": "number" }, "tpaInvoiceId": { "type": "number" }, "affiliateId": { "type": "number" }, "statusId": { "type": "number" }, "discountPercentage": { "type": "number" }, "notes": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "Payment": { "title": "Payment", "type": "object", "properties": { "id": { "type": "string" }, "transactionId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "companyId": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "nullable": true }, "toCompanyId": { "type": "number" }, "fromCompanyId": { "type": "number" }, "toUserId": { "type": "string" }, "to": { "type": "string" }, "fromUserId": { "type": "string" }, "from": { "type": "string" }, "toClearErc": { "type": "boolean" }, "fromClearErc": { "type": "boolean" }, "reference": { "type": "string" }, "notes": { "type": "string" }, "description": { "type": "string" }, "paymentRequestId": { "type": "string" }, "lineItemId": { "type": "number" }, "invoiceId": { "type": "number" }, "stripeChargeId": { "type": "string" }, "qbPaymentId": { "type": "string" }, "type": { "type": "string" }, "quarter": { "type": "string" }, "receivedByPaymasterAt": { "type": "string", "format": "date-time" }, "chequeNumber": { "type": "string" }, "interest": { "type": "number", "nullable": true }, "taxes": { "type": "number", "nullable": true }, "forCompanyId": { "type": "number" }, "wireFee": { "type": "number", "nullable": true }, "currency": { "type": "string" }, "method": { "type": "string" }, "status": { "type": "string" }, "initiatedAt": { "type": "string", "format": "date-time" }, "confirmedAt": { "type": "string", "format": "date-time" }, "sentById": { "type": "string" }, "confirmedById": { "type": "string" }, "wireTraceNumber": { "type": "string" }, "wireMemo": { "type": "string" }, "reconciled": { "type": "boolean" }, "reconciledById": { "type": "string" }, "reconciledAt": { "type": "string", "format": "date-time" }, "externalRef": { "type": "string" }, "voidedAt": { "type": "string", "format": "date-time" }, "voidedById": { "type": "string" }, "reversalOfPaymentId": { "type": "string" }, "batchId": { "type": "string" } }, "required": [ "date" ], "additionalProperties": false }, "LineItems": { "title": "LineItems", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "percentageOfFinal": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isCommisionable": { "type": "number", "nullable": false }, "price": { "type": "number" }, "isPublic": { "type": "number", "nullable": false }, "stripeProductId": { "type": "string" }, "qbItemId": { "type": "string" }, "skipSync": { "type": "boolean" } }, "required": [ "isCommisionable", "isPublic" ], "additionalProperties": false }, "TransactionWithRelations": { "title": "TransactionWithRelations", "type": "object", "description": "(tsType: TransactionWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "paymentId": { "type": "string" }, "createdById": { "type": "string" }, "companyId": { "type": "number" }, "lineItemId": { "type": "number" }, "toCompanyId": { "type": "number" }, "fromCompanyId": { "type": "number" }, "toUserId": { "type": "string" }, "companyType": { "type": "string" }, "to": { "type": "string" }, "deletedBy": { "type": "string" }, "fromUserId": { "type": "string" }, "from": { "type": "string" }, "type": { "type": "string" }, "isDeleted": { "type": "boolean" }, "toUs": { "type": "boolean" }, "fromUs": { "type": "boolean" }, "amount": { "type": "number", "nullable": true }, "amountPerLife": { "type": "number", "nullable": true }, "lives": { "type": "number", "nullable": true }, "lineItemID": { "type": "number" }, "tpaInvoiceId": { "type": "number" }, "affiliateId": { "type": "number" }, "statusId": { "type": "number" }, "discountPercentage": { "type": "number" }, "notes": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" }, "payment": { "$ref": "#/components/schemas/Payment" }, "foreignKey": {}, "createdByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "company": { "$ref": "#/components/schemas/Company" }, "lineItem": { "$ref": "#/components/schemas/LineItems" }, "toCompany": { "$ref": "#/components/schemas/Company" }, "fromCompany": { "$ref": "#/components/schemas/Company" }, "toUser": { "$ref": "#/components/schemas/MarshalledUser" }, "fromUser": { "$ref": "#/components/schemas/MarshalledUser" } }, "additionalProperties": false, "x-typescript-type": "TransactionWithRelations" }, "TransactionPartial": { "title": "TransactionPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "paymentId": { "type": "string" }, "createdById": { "type": "string" }, "companyId": { "type": "number" }, "lineItemId": { "type": "number" }, "toCompanyId": { "type": "number" }, "fromCompanyId": { "type": "number" }, "toUserId": { "type": "string" }, "companyType": { "type": "string" }, "to": { "type": "string" }, "deletedBy": { "type": "string" }, "fromUserId": { "type": "string" }, "from": { "type": "string" }, "type": { "type": "string" }, "isDeleted": { "type": "boolean" }, "toUs": { "type": "boolean" }, "fromUs": { "type": "boolean" }, "amount": { "type": "number", "nullable": true }, "amountPerLife": { "type": "number", "nullable": true }, "lives": { "type": "number", "nullable": true }, "lineItemID": { "type": "number" }, "tpaInvoiceId": { "type": "number" }, "affiliateId": { "type": "number" }, "statusId": { "type": "number" }, "discountPercentage": { "type": "number" }, "notes": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "TransactionStatus": { "title": "TransactionStatus", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewTransactionStatus": { "title": "NewTransactionStatus", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewTransactionStatus', exclude: [ 'id' ] })", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "TransactionStatusWithRelations": { "title": "TransactionStatusWithRelations", "type": "object", "description": "(tsType: TransactionStatusWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "TransactionStatusWithRelations" }, "TransactionStatusPartial": { "title": "TransactionStatusPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "TransactionStatusHistory": { "title": "TransactionStatusHistory", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "transactionId": { "type": "string", "nullable": true }, "preValue": { "type": "number", "nullable": true }, "postValue": { "type": "number", "nullable": true }, "changeDatetime": { "type": "string", "format": "date-time", "nullable": true }, "changedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewTransactionStatusHistory": { "title": "NewTransactionStatusHistory", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewTransactionStatusHistory', exclude: [ 'id' ] })", "properties": { "transactionId": { "type": "string", "nullable": true }, "preValue": { "type": "number", "nullable": true }, "postValue": { "type": "number", "nullable": true }, "changeDatetime": { "type": "string", "format": "date-time", "nullable": true }, "changedBy": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "TransactionStatusHistoryWithRelations": { "title": "TransactionStatusHistoryWithRelations", "type": "object", "description": "(tsType: TransactionStatusHistoryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "transactionId": { "type": "string", "nullable": true }, "preValue": { "type": "number", "nullable": true }, "postValue": { "type": "number", "nullable": true }, "changeDatetime": { "type": "string", "format": "date-time", "nullable": true }, "changedBy": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "TransactionStatusHistoryWithRelations" }, "TransactionStatusHistoryPartial": { "title": "TransactionStatusHistoryPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "transactionId": { "type": "string", "nullable": true }, "preValue": { "type": "number", "nullable": true }, "postValue": { "type": "number", "nullable": true }, "changeDatetime": { "type": "string", "format": "date-time", "nullable": true }, "changedBy": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "TpaCompanyAlias": { "title": "TpaCompanyAlias", "type": "object", "properties": { "id": { "type": "number" }, "label": { "type": "string" }, "companyId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "label", "companyId" ], "additionalProperties": false }, "TpaInvoices": { "title": "TpaInvoices", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": true }, "lives": { "type": "number", "nullable": true }, "pricePerLife": { "type": "number", "nullable": true }, "groupAdvisorsPayout": { "type": "number", "nullable": true }, "affiliateUserId": { "type": "string", "nullable": true }, "salesRepId": { "type": "string", "nullable": true }, "affiliateManagerId": { "type": "string", "nullable": true }, "affiliateAmount": { "type": "number", "nullable": true }, "salesRepAmount": { "type": "number", "nullable": true }, "affiliateManagerAmount": { "type": "number", "nullable": true }, "subAffiliateUserId": { "type": "string", "nullable": true }, "subAffiliateAmount": { "type": "number", "nullable": true }, "subSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubAffiliateAmount": { "type": "number", "nullable": true }, "subSubSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubSubAffiliateAmount": { "type": "number", "nullable": true }, "referrer1Id": { "type": "string", "nullable": true }, "referrer1Amount": { "type": "number", "nullable": true }, "referrer2Id": { "type": "string", "nullable": true }, "referrer2Amount": { "type": "number", "nullable": true }, "referrer3Id": { "type": "string", "nullable": true }, "referrer3Amount": { "type": "number", "nullable": true }, "referrer4Id": { "type": "string", "nullable": true }, "referrer4Amount": { "type": "number", "nullable": true }, "referrer5Id": { "type": "string", "nullable": true }, "referrer5Amount": { "type": "number", "nullable": true }, "referrer6Id": { "type": "string", "nullable": true }, "referrer6Amount": { "type": "number", "nullable": true }, "erFee": { "type": "number", "nullable": true }, "erLives": { "type": "number", "nullable": true }, "totalEmployeePrice": { "type": "number", "nullable": true }, "totalEmployerPrice": { "type": "number", "nullable": true }, "totalUSHealthPrice": { "type": "number", "nullable": true }, "totalInsurancePrice": { "type": "number", "nullable": true }, "totalGrossPayout": { "type": "number", "nullable": true }, "grossProfit": { "type": "number", "nullable": true }, "details": { "type": "object", "nullable": true }, "invoiceDatetime": { "type": "string", "format": "date-time", "nullable": true }, "payPeriod": { "type": "number", "nullable": true }, "achRejected": { "type": "number" }, "payDate": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "employerPricePerLife": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewTpaInvoices": { "title": "NewTpaInvoices", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewTpaInvoices', exclude: [ 'id' ] })", "properties": { "companyId": { "type": "number", "nullable": true }, "lives": { "type": "number", "nullable": true }, "pricePerLife": { "type": "number", "nullable": true }, "groupAdvisorsPayout": { "type": "number", "nullable": true }, "affiliateUserId": { "type": "string", "nullable": true }, "salesRepId": { "type": "string", "nullable": true }, "affiliateManagerId": { "type": "string", "nullable": true }, "affiliateAmount": { "type": "number", "nullable": true }, "salesRepAmount": { "type": "number", "nullable": true }, "affiliateManagerAmount": { "type": "number", "nullable": true }, "subAffiliateUserId": { "type": "string", "nullable": true }, "subAffiliateAmount": { "type": "number", "nullable": true }, "subSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubAffiliateAmount": { "type": "number", "nullable": true }, "subSubSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubSubAffiliateAmount": { "type": "number", "nullable": true }, "referrer1Id": { "type": "string", "nullable": true }, "referrer1Amount": { "type": "number", "nullable": true }, "referrer2Id": { "type": "string", "nullable": true }, "referrer2Amount": { "type": "number", "nullable": true }, "referrer3Id": { "type": "string", "nullable": true }, "referrer3Amount": { "type": "number", "nullable": true }, "referrer4Id": { "type": "string", "nullable": true }, "referrer4Amount": { "type": "number", "nullable": true }, "referrer5Id": { "type": "string", "nullable": true }, "referrer5Amount": { "type": "number", "nullable": true }, "referrer6Id": { "type": "string", "nullable": true }, "referrer6Amount": { "type": "number", "nullable": true }, "erFee": { "type": "number", "nullable": true }, "erLives": { "type": "number", "nullable": true }, "totalEmployeePrice": { "type": "number", "nullable": true }, "totalEmployerPrice": { "type": "number", "nullable": true }, "totalUSHealthPrice": { "type": "number", "nullable": true }, "totalInsurancePrice": { "type": "number", "nullable": true }, "totalGrossPayout": { "type": "number", "nullable": true }, "grossProfit": { "type": "number", "nullable": true }, "details": { "type": "object", "nullable": true }, "invoiceDatetime": { "type": "string", "format": "date-time", "nullable": true }, "payPeriod": { "type": "number", "nullable": true }, "achRejected": { "type": "number" }, "payDate": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "employerPricePerLife": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "TpaInvoicesWithRelations": { "title": "TpaInvoicesWithRelations", "type": "object", "description": "(tsType: TpaInvoicesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": true }, "lives": { "type": "number", "nullable": true }, "pricePerLife": { "type": "number", "nullable": true }, "groupAdvisorsPayout": { "type": "number", "nullable": true }, "affiliateUserId": { "type": "string", "nullable": true }, "salesRepId": { "type": "string", "nullable": true }, "affiliateManagerId": { "type": "string", "nullable": true }, "affiliateAmount": { "type": "number", "nullable": true }, "salesRepAmount": { "type": "number", "nullable": true }, "affiliateManagerAmount": { "type": "number", "nullable": true }, "subAffiliateUserId": { "type": "string", "nullable": true }, "subAffiliateAmount": { "type": "number", "nullable": true }, "subSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubAffiliateAmount": { "type": "number", "nullable": true }, "subSubSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubSubAffiliateAmount": { "type": "number", "nullable": true }, "referrer1Id": { "type": "string", "nullable": true }, "referrer1Amount": { "type": "number", "nullable": true }, "referrer2Id": { "type": "string", "nullable": true }, "referrer2Amount": { "type": "number", "nullable": true }, "referrer3Id": { "type": "string", "nullable": true }, "referrer3Amount": { "type": "number", "nullable": true }, "referrer4Id": { "type": "string", "nullable": true }, "referrer4Amount": { "type": "number", "nullable": true }, "referrer5Id": { "type": "string", "nullable": true }, "referrer5Amount": { "type": "number", "nullable": true }, "referrer6Id": { "type": "string", "nullable": true }, "referrer6Amount": { "type": "number", "nullable": true }, "erFee": { "type": "number", "nullable": true }, "erLives": { "type": "number", "nullable": true }, "totalEmployeePrice": { "type": "number", "nullable": true }, "totalEmployerPrice": { "type": "number", "nullable": true }, "totalUSHealthPrice": { "type": "number", "nullable": true }, "totalInsurancePrice": { "type": "number", "nullable": true }, "totalGrossPayout": { "type": "number", "nullable": true }, "grossProfit": { "type": "number", "nullable": true }, "details": { "type": "object", "nullable": true }, "invoiceDatetime": { "type": "string", "format": "date-time", "nullable": true }, "payPeriod": { "type": "number", "nullable": true }, "achRejected": { "type": "number" }, "payDate": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "employerPricePerLife": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "TpaInvoicesWithRelations" }, "TpaInvoicesPartial": { "title": "TpaInvoicesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": true }, "lives": { "type": "number", "nullable": true }, "pricePerLife": { "type": "number", "nullable": true }, "groupAdvisorsPayout": { "type": "number", "nullable": true }, "affiliateUserId": { "type": "string", "nullable": true }, "salesRepId": { "type": "string", "nullable": true }, "affiliateManagerId": { "type": "string", "nullable": true }, "affiliateAmount": { "type": "number", "nullable": true }, "salesRepAmount": { "type": "number", "nullable": true }, "affiliateManagerAmount": { "type": "number", "nullable": true }, "subAffiliateUserId": { "type": "string", "nullable": true }, "subAffiliateAmount": { "type": "number", "nullable": true }, "subSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubAffiliateAmount": { "type": "number", "nullable": true }, "subSubSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubSubAffiliateAmount": { "type": "number", "nullable": true }, "referrer1Id": { "type": "string", "nullable": true }, "referrer1Amount": { "type": "number", "nullable": true }, "referrer2Id": { "type": "string", "nullable": true }, "referrer2Amount": { "type": "number", "nullable": true }, "referrer3Id": { "type": "string", "nullable": true }, "referrer3Amount": { "type": "number", "nullable": true }, "referrer4Id": { "type": "string", "nullable": true }, "referrer4Amount": { "type": "number", "nullable": true }, "referrer5Id": { "type": "string", "nullable": true }, "referrer5Amount": { "type": "number", "nullable": true }, "referrer6Id": { "type": "string", "nullable": true }, "referrer6Amount": { "type": "number", "nullable": true }, "erFee": { "type": "number", "nullable": true }, "erLives": { "type": "number", "nullable": true }, "totalEmployeePrice": { "type": "number", "nullable": true }, "totalEmployerPrice": { "type": "number", "nullable": true }, "totalUSHealthPrice": { "type": "number", "nullable": true }, "totalInsurancePrice": { "type": "number", "nullable": true }, "totalGrossPayout": { "type": "number", "nullable": true }, "grossProfit": { "type": "number", "nullable": true }, "details": { "type": "object", "nullable": true }, "invoiceDatetime": { "type": "string", "format": "date-time", "nullable": true }, "payPeriod": { "type": "number", "nullable": true }, "achRejected": { "type": "number" }, "payDate": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "employerPricePerLife": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "StuckStageRule": { "title": "StuckStageRule", "type": "object", "properties": { "id": { "type": "number" }, "stageId": { "type": "number" }, "maxDays": { "type": "number" }, "recipient": { "type": "string" }, "renotifyDays": { "type": "number", "nullable": true }, "enabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "stageId", "maxDays", "recipient" ], "additionalProperties": false }, "Buffer": {}, "StepRuleGroups": { "title": "StepRuleGroups", "type": "object", "properties": { "businessRuleGroupId": { "type": "number" }, "id": { "type": "number" }, "processflowId": { "type": "number" } }, "additionalProperties": false }, "NewStepRuleGroups": { "title": "NewStepRuleGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewStepRuleGroups', exclude: [ 'id' ] })", "properties": { "businessRuleGroupId": { "type": "number" }, "processflowId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "StepRuleGroupsWithRelations": { "title": "StepRuleGroupsWithRelations", "type": "object", "description": "(tsType: StepRuleGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "businessRuleGroupId": { "type": "number" }, "id": { "type": "number" }, "processflowId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "StepRuleGroupsWithRelations" }, "StepRuleGroupsPartial": { "title": "StepRuleGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "businessRuleGroupId": { "type": "number" }, "id": { "type": "number" }, "processflowId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Stages": { "title": "Stages", "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "parent": { "type": "number", "nullable": false }, "productId": { "type": "number", "nullable": true }, "requiredRoleGroup": { "type": "number", "nullable": true } }, "required": [ "isAccountant", "isPublic", "parent" ], "additionalProperties": false }, "NewStages": { "title": "NewStages", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewStages', exclude: [ 'id' ] })", "properties": { "description": { "type": "string", "nullable": true }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "parent": { "type": "number", "nullable": false }, "productId": { "type": "number", "nullable": true }, "requiredRoleGroup": { "type": "number", "nullable": true } }, "required": [ "isAccountant", "isPublic", "parent" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "StagesWithRelations": { "title": "StagesWithRelations", "type": "object", "description": "(tsType: StagesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "parent": { "type": "number", "nullable": false }, "productId": { "type": "number", "nullable": true }, "requiredRoleGroup": { "type": "number", "nullable": true } }, "required": [ "isAccountant", "isPublic", "parent" ], "additionalProperties": false, "x-typescript-type": "StagesWithRelations" }, "StagesPartial": { "title": "StagesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "parent": { "type": "number", "nullable": false }, "productId": { "type": "number", "nullable": true }, "requiredRoleGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "StageHistory": { "title": "StageHistory", "type": "object", "properties": { "id": { "type": "number" }, "processflow": { "type": "number" }, "stageFrom": { "type": "number" }, "stageTo": { "type": "number" }, "changeWhen": { "type": "string", "format": "date-time" }, "syncChange": { "type": "number" }, "changeBy": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "syncChange" ], "additionalProperties": false }, "NewStageHistory": { "title": "NewStageHistory", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewStageHistory', exclude: [ 'id' ] })", "properties": { "processflow": { "type": "number" }, "stageFrom": { "type": "number" }, "stageTo": { "type": "number" }, "changeWhen": { "type": "string", "format": "date-time" }, "syncChange": { "type": "number" }, "changeBy": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "syncChange" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "StageHistoryWithRelations": { "title": "StageHistoryWithRelations", "type": "object", "description": "(tsType: StageHistoryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "processflow": { "type": "number" }, "stageFrom": { "type": "number" }, "stageTo": { "type": "number" }, "changeWhen": { "type": "string", "format": "date-time" }, "syncChange": { "type": "number" }, "changeBy": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "syncChange" ], "additionalProperties": false, "x-typescript-type": "StageHistoryWithRelations" }, "StageHistoryPartial": { "title": "StageHistoryPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "processflow": { "type": "number" }, "stageFrom": { "type": "number" }, "stageTo": { "type": "number" }, "changeWhen": { "type": "string", "format": "date-time" }, "syncChange": { "type": "number" }, "changeBy": { "type": "string" }, "notes": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Sms": { "title": "Sms", "type": "object", "properties": { "to": { "type": "string" }, "from": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string" } }, "required": [ "to", "from", "body" ], "additionalProperties": false }, "SendSMS": { "title": "SendSMS", "type": "object", "description": "(tsType: Sms, schemaOptions: { title: 'SendSMS' })", "properties": { "to": { "type": "string" }, "from": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string" } }, "required": [ "to", "from", "body" ], "additionalProperties": false, "x-typescript-type": "Sms" }, "SmsMessage": { "title": "SmsMessage", "type": "object", "properties": { "id": { "type": "number" }, "direction": { "type": "string" }, "fromNumber": { "type": "string" }, "toNumber": { "type": "string" }, "body": { "type": "string" }, "messageSid": { "type": "string" }, "numMedia": { "type": "number" }, "mediaJson": { "type": "string" }, "payloadJson": { "type": "string" }, "userId": { "type": "string" }, "companyId": { "type": "number" }, "status": { "type": "string" }, "staffAssistantThreadId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "SignedContracts": { "title": "SignedContracts", "type": "object", "properties": { "id": { "type": "number" }, "contractType": { "type": "string", "nullable": false }, "companyName": { "type": "string", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "companyState": { "type": "string", "nullable": true }, "companyAddress": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "perEntireMonthlyLifePerMonth": { "type": "string", "nullable": true }, "printName": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "effectiveDate": { "type": "string", "nullable": true }, "signatureText": { "type": "string", "nullable": true }, "signatureFont": { "type": "string", "nullable": true }, "signingIpAddress": { "type": "string", "nullable": true }, "signerEmail": { "type": "string", "nullable": true }, "pdfFieldValues": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "signedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "dateUpdated": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "renderedPdfFilename": { "type": "string", "nullable": true }, "voidedAt": { "type": "string", "format": "date-time", "nullable": true }, "voidedById": { "type": "string", "nullable": true }, "voidReason": { "type": "string", "nullable": true }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "deletedById": { "type": "string", "nullable": true } }, "required": [ "contractType" ], "additionalProperties": false }, "SignedContractsWithRelations": { "title": "SignedContractsWithRelations", "type": "object", "description": "(tsType: SignedContractsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "contractType": { "type": "string", "nullable": false }, "companyName": { "type": "string", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "companyState": { "type": "string", "nullable": true }, "companyAddress": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "perEntireMonthlyLifePerMonth": { "type": "string", "nullable": true }, "printName": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "effectiveDate": { "type": "string", "nullable": true }, "signatureText": { "type": "string", "nullable": true }, "signatureFont": { "type": "string", "nullable": true }, "signingIpAddress": { "type": "string", "nullable": true }, "signerEmail": { "type": "string", "nullable": true }, "pdfFieldValues": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "signedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "dateUpdated": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "renderedPdfFilename": { "type": "string", "nullable": true }, "voidedAt": { "type": "string", "format": "date-time", "nullable": true }, "voidedById": { "type": "string", "nullable": true }, "voidReason": { "type": "string", "nullable": true }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "deletedById": { "type": "string", "nullable": true } }, "required": [ "contractType" ], "additionalProperties": false, "x-typescript-type": "SignedContractsWithRelations" }, "UserSettings": { "title": "UserSettings", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "string" }, "settingName": { "type": "string" }, "settingValue": { "type": "string" } }, "additionalProperties": false }, "NewUserSettings": { "title": "NewUserSettings", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewUserSettings', exclude: [ 'id' ] })", "properties": { "userId": { "type": "string" }, "settingName": { "type": "string" }, "settingValue": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UserSettingsWithRelations": { "title": "UserSettingsWithRelations", "type": "object", "description": "(tsType: UserSettingsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "string" }, "settingName": { "type": "string" }, "settingValue": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "UserSettingsWithRelations" }, "UserSettingsPartial": { "title": "UserSettingsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "string" }, "settingName": { "type": "string" }, "settingValue": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "SalesMaterial": { "title": "SalesMaterial", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "s3Key": { "type": "string" }, "originalFilename": { "type": "string" }, "mimetype": { "type": "string", "nullable": true }, "size": { "type": "number", "nullable": true }, "status": { "type": "string" }, "audience": { "type": "string", "enum": [ "partner", "employer", "both" ] }, "kind": { "type": "string", "enum": [ "document", "presentation" ] }, "personalization": { "type": "object" }, "sourceCompanyDocumentId": { "type": "number", "nullable": true }, "retiredAt": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "s3Key", "originalFilename", "status", "audience", "kind" ], "additionalProperties": false }, "CensusImport": { "title": "CensusImport", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "uploadedByUserId": { "type": "string" }, "fileUploadId": { "type": "number" }, "fileName": { "type": "string" }, "uploadedAt": { "type": "string", "format": "date-time" }, "rowCount": { "type": "number", "nullable": true }, "status": { "type": "string", "enum": [ "processing", "complete", "failed" ] }, "errors": { "type": "object", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "companyId", "uploadedByUserId", "fileUploadId", "fileName" ], "additionalProperties": false }, "AnalysisRun": { "title": "AnalysisRun", "type": "object", "properties": { "id": { "type": "string" }, "censusImportId": { "type": "number" }, "companyId": { "type": "number" }, "runAt": { "type": "string", "format": "date-time" }, "totalEmployees": { "type": "number" }, "eligibleEmployees": { "type": "number" }, "annualEmployeeSavings": { "type": "number" }, "annualEmployerNetSavings": { "type": "number" }, "annualEmployerFees": { "type": "number" }, "report": { "type": "object" }, "reportParity": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "censusImportId", "companyId", "totalEmployees", "eligibleEmployees", "annualEmployeeSavings", "annualEmployerNetSavings", "annualEmployerFees", "report" ], "additionalProperties": false }, "NewRoles": { "title": "NewRoles", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRoles', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "roleCode": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "RolesWithRelations": { "title": "RolesWithRelations", "type": "object", "description": "(tsType: RolesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "roleCode": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "RolesWithRelations" }, "RoleUsers": { "title": "RoleUsers", "type": "object", "properties": { "id": { "type": "number" }, "roleId": { "type": "number" }, "userId": { "type": "string" } }, "additionalProperties": false }, "NewRoleUsers": { "title": "NewRoleUsers", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRoleUsers', exclude: [ 'id' ] })", "properties": { "roleId": { "type": "number" }, "userId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "RoleUsersWithRelations": { "title": "RoleUsersWithRelations", "type": "object", "description": "(tsType: RoleUsersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "roleId": { "type": "number" }, "userId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "RoleUsersWithRelations" }, "RoleUsersPartial": { "title": "RoleUsersPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "roleId": { "type": "number" }, "userId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewRoleGroups": { "title": "NewRoleGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRoleGroups', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "owner": { "type": "number" }, "isPublic": { "type": "number" }, "isForCompany": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ProcessflowGroup": { "title": "ProcessflowGroup", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false }, "RoleGroupsWithRelations": { "title": "RoleGroupsWithRelations", "type": "object", "description": "(tsType: RoleGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "owner": { "type": "number" }, "isPublic": { "type": "number" }, "isForCompany": { "type": "number" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Roles" } }, "processflowGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessflowGroup" } } }, "additionalProperties": false, "x-typescript-type": "RoleGroupsWithRelations" }, "RoleGroupsPartial": { "title": "RoleGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "owner": { "type": "number" }, "isPublic": { "type": "number" }, "isForCompany": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewRolesInRoleGroups": { "title": "NewRolesInRoleGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRolesInRoleGroups', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "roleCode": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "NewProcessflowGroupInRoleGroups": { "title": "NewProcessflowGroupInRoleGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewProcessflowGroupInRoleGroups', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ProcessflowGroupPartial": { "title": "ProcessflowGroupPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "RoleGroupUsers": { "title": "RoleGroupUsers", "type": "object", "properties": { "id": { "type": "number" }, "roleGroupsId": { "type": "number" }, "clearErcUserId": { "type": "string" } }, "additionalProperties": false }, "NewRoleGroupUsers": { "title": "NewRoleGroupUsers", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRoleGroupUsers', exclude: [ 'id' ] })", "properties": { "roleGroupsId": { "type": "number" }, "clearErcUserId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "RoleGroupUsersWithRelations": { "title": "RoleGroupUsersWithRelations", "type": "object", "description": "(tsType: RoleGroupUsersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "roleGroupsId": { "type": "number" }, "clearErcUserId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "RoleGroupUsersWithRelations" }, "RoleGroupUsersPartial": { "title": "RoleGroupUsersPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "roleGroupsId": { "type": "number" }, "clearErcUserId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "RoleGroupEntries": { "title": "RoleGroupEntries", "type": "object", "properties": { "id": { "type": "number" }, "roleId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false }, "NewRoleGroupEntries": { "title": "NewRoleGroupEntries", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRoleGroupEntries', exclude: [ 'id' ] })", "properties": { "roleId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "RoleGroupEntriesWithRelations": { "title": "RoleGroupEntriesWithRelations", "type": "object", "description": "(tsType: RoleGroupEntriesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "roleId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "RoleGroupEntriesWithRelations" }, "RoleGroupEntriesPartial": { "title": "RoleGroupEntriesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "roleId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "RewardActivityType": { "title": "RewardActivityType", "type": "object", "properties": { "id": { "type": "number" }, "slug": { "type": "string" }, "name": { "type": "string" }, "level": { "type": "string", "nullable": true }, "groupSlug": { "type": "string", "nullable": true }, "cptCode": { "type": "string", "nullable": true }, "valueCents": { "type": "number", "nullable": true }, "frequencyCap": { "type": "number", "nullable": true }, "frequencyPeriod": { "type": "string", "enum": [ "day", "month", "quarter", "plan_year", "lifetime" ] }, "documentationRequired": { "type": "boolean" }, "active": { "type": "boolean" }, "effectiveFrom": { "type": "string", "format": "date-time" }, "effectiveTo": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "slug", "name", "effectiveFrom" ], "additionalProperties": false }, "RepairStages": { "title": "RepairStages", "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "parent": { "type": "number", "nullable": false }, "requiredRoleGroup": { "type": "number", "nullable": true }, "title": { "type": "string", "nullable": true } }, "required": [ "isAccountant", "isPublic", "parent" ], "additionalProperties": false }, "NewRepairStages": { "title": "NewRepairStages", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRepairStages', exclude: [ 'id' ] })", "properties": { "description": { "type": "string", "nullable": true }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "parent": { "type": "number", "nullable": false }, "requiredRoleGroup": { "type": "number", "nullable": true }, "title": { "type": "string", "nullable": true } }, "required": [ "isAccountant", "isPublic", "parent" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "RepairStagesWithRelations": { "title": "RepairStagesWithRelations", "type": "object", "description": "(tsType: RepairStagesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "parent": { "type": "number", "nullable": false }, "requiredRoleGroup": { "type": "number", "nullable": true }, "title": { "type": "string", "nullable": true } }, "required": [ "isAccountant", "isPublic", "parent" ], "additionalProperties": false, "x-typescript-type": "RepairStagesWithRelations" }, "RepairStagesPartial": { "title": "RepairStagesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "parent": { "type": "number", "nullable": false }, "requiredRoleGroup": { "type": "number", "nullable": true }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "RepairStageHistory": { "title": "RepairStageHistory", "type": "object", "properties": { "changeBy": { "type": "string", "nullable": true }, "changeWhen": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "number", "nullable": false }, "notes": { "type": "string", "nullable": true }, "processflow": { "type": "number", "nullable": true }, "stageFrom": { "type": "number", "nullable": true }, "stageTo": { "type": "number", "nullable": true }, "syncChange": { "type": "number", "nullable": false } }, "required": [ "syncChange" ], "additionalProperties": false }, "NewRepairStageHistory": { "title": "NewRepairStageHistory", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRepairStageHistory', exclude: [ 'id' ] })", "properties": { "changeBy": { "type": "string", "nullable": true }, "changeWhen": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "processflow": { "type": "number", "nullable": true }, "stageFrom": { "type": "number", "nullable": true }, "stageTo": { "type": "number", "nullable": true }, "syncChange": { "type": "number", "nullable": false } }, "required": [ "syncChange" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "RepairStageHistoryWithRelations": { "title": "RepairStageHistoryWithRelations", "type": "object", "description": "(tsType: RepairStageHistoryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "changeBy": { "type": "string", "nullable": true }, "changeWhen": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "number", "nullable": false }, "notes": { "type": "string", "nullable": true }, "processflow": { "type": "number", "nullable": true }, "stageFrom": { "type": "number", "nullable": true }, "stageTo": { "type": "number", "nullable": true }, "syncChange": { "type": "number", "nullable": false } }, "required": [ "syncChange" ], "additionalProperties": false, "x-typescript-type": "RepairStageHistoryWithRelations" }, "RepairStageHistoryPartial": { "title": "RepairStageHistoryPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "changeBy": { "type": "string", "nullable": true }, "changeWhen": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "number", "nullable": false }, "notes": { "type": "string", "nullable": true }, "processflow": { "type": "number", "nullable": true }, "stageFrom": { "type": "number", "nullable": true }, "stageTo": { "type": "number", "nullable": true }, "syncChange": { "type": "number", "nullable": false } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "RepairStageCategories": { "title": "RepairStageCategories", "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "requiredRoleGroup": { "type": "number", "nullable": true } }, "required": [ "isAccountant", "isPublic" ], "additionalProperties": false }, "NewRepairStageCategories": { "title": "NewRepairStageCategories", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRepairStageCategories', exclude: [ 'id' ] })", "properties": { "description": { "type": "string", "nullable": true }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "requiredRoleGroup": { "type": "number", "nullable": true } }, "required": [ "isAccountant", "isPublic" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "RepairStageCategoriesWithRelations": { "title": "RepairStageCategoriesWithRelations", "type": "object", "description": "(tsType: RepairStageCategoriesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "requiredRoleGroup": { "type": "number", "nullable": true } }, "required": [ "isAccountant", "isPublic" ], "additionalProperties": false, "x-typescript-type": "RepairStageCategoriesWithRelations" }, "RepairStageCategoriesPartial": { "title": "RepairStageCategoriesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "isAccountant": { "type": "number", "nullable": false }, "isPublic": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "requiredRoleGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Referrer": { "title": "Referrer", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "commissionPercentage": { "type": "number" }, "referrerId": { "type": "string" }, "affiliateId": { "type": "string" } }, "additionalProperties": false }, "NewReferrer": { "title": "NewReferrer", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewReferrer', exclude: [ 'id' ] })", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "commissionPercentage": { "type": "number" }, "referrerId": { "type": "string" }, "affiliateId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ReferrerWithRelations": { "title": "ReferrerWithRelations", "type": "object", "description": "(tsType: ReferrerWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "commissionPercentage": { "type": "number" }, "referrerId": { "type": "string" }, "affiliateId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "ReferrerWithRelations" }, "ReferrerPartial": { "title": "ReferrerPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "commissionPercentage": { "type": "number" }, "referrerId": { "type": "string" }, "affiliateId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "QuestionForJason": { "title": "QuestionForJason", "type": "object", "properties": { "id": { "type": "number" }, "question": { "type": "string" }, "tag": { "type": "string", "nullable": true }, "answered": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "question" ], "additionalProperties": false }, "Prospect": { "title": "Prospect", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string" }, "phone": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "w2Count": { "type": "number", "nullable": true }, "status": { "type": "string", "enum": [ "prospect", "converted", "not_interested" ] }, "unsubscribedAt": { "type": "string", "format": "date-time", "nullable": true }, "bouncedAt": { "type": "string", "format": "date-time", "nullable": true }, "complainedAt": { "type": "string", "format": "date-time", "nullable": true }, "convertedCompanyId": { "type": "number", "nullable": true }, "attributedCampaignId": { "type": "number", "nullable": true }, "convertedAt": { "type": "string", "format": "date-time", "nullable": true }, "convertedBy": { "type": "string", "nullable": true }, "convertedBookingId": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "companyId", "email" ], "additionalProperties": false }, "Products": { "title": "Products", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewProducts": { "title": "NewProducts", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewProducts', exclude: [ 'id' ] })", "properties": { "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ProductsWithRelations": { "title": "ProductsWithRelations", "type": "object", "description": "(tsType: ProductsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "ProductsWithRelations" }, "ProductsPartial": { "title": "ProductsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Processflow": { "title": "Processflow", "type": "object", "properties": { "id": { "type": "number" }, "group": { "type": "number" }, "title": { "type": "string" }, "details": { "type": "string" }, "order": { "type": "number" }, "reliesOnTrue": { "type": "number" }, "reliesOnFalse": { "type": "number" }, "inputType": { "type": "number" }, "checkboxEntries": { "type": "object" }, "fileUploadEntries": { "type": "object" }, "stateEntries": { "type": "object" }, "yesNoEntries": { "type": "string" }, "selectBoxEntries": {}, "entries": { "type": "string" }, "datePickerEntries": { "type": "object" }, "textareaEntries": { "type": "object" }, "optional": { "type": "number" }, "internalOnly": { "type": "number" }, "sendsEmailOnCompletion": { "type": "number" }, "causesRepContactOnCompletion": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" }, "stage": { "type": "number" }, "internalComments": { "type": "string" }, "textfieldName": { "type": "string" }, "helpDoc": { "type": "number" }, "checkboxEnabler": { "type": "string" }, "textfieldEntries": { "type": "object" } }, "required": [ "optional", "internalOnly", "sendsEmailOnCompletion", "causesRepContactOnCompletion", "ruleGroupsAreOr" ], "additionalProperties": false }, "NewProcessflow": { "title": "NewProcessflow", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewProcessflow', exclude: [ 'id' ] })", "properties": { "group": { "type": "number" }, "title": { "type": "string" }, "details": { "type": "string" }, "order": { "type": "number" }, "reliesOnTrue": { "type": "number" }, "reliesOnFalse": { "type": "number" }, "inputType": { "type": "number" }, "checkboxEntries": { "type": "object" }, "fileUploadEntries": { "type": "object" }, "stateEntries": { "type": "object" }, "yesNoEntries": { "type": "string" }, "selectBoxEntries": {}, "entries": { "type": "string" }, "datePickerEntries": { "type": "object" }, "textareaEntries": { "type": "object" }, "optional": { "type": "number" }, "internalOnly": { "type": "number" }, "sendsEmailOnCompletion": { "type": "number" }, "causesRepContactOnCompletion": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" }, "stage": { "type": "number" }, "internalComments": { "type": "string" }, "textfieldName": { "type": "string" }, "helpDoc": { "type": "number" }, "checkboxEnabler": { "type": "string" }, "textfieldEntries": { "type": "object" } }, "required": [ "optional", "internalOnly", "sendsEmailOnCompletion", "causesRepContactOnCompletion", "ruleGroupsAreOr" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BusinessRuleGroup": { "title": "BusinessRuleGroup", "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "isQualify": { "type": "number" }, "isAnd": { "type": "number" }, "product": { "type": "number" }, "folder": { "type": "number" }, "name": { "type": "string" } }, "required": [ "isQualify", "isAnd", "product" ], "additionalProperties": false }, "ProcessflowWithRelations": { "title": "ProcessflowWithRelations", "type": "object", "description": "(tsType: ProcessflowWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "group": { "type": "number" }, "title": { "type": "string" }, "details": { "type": "string" }, "order": { "type": "number" }, "reliesOnTrue": { "type": "number" }, "reliesOnFalse": { "type": "number" }, "inputType": { "type": "number" }, "checkboxEntries": { "type": "object" }, "fileUploadEntries": { "type": "object" }, "stateEntries": { "type": "object" }, "yesNoEntries": { "type": "string" }, "selectBoxEntries": {}, "entries": { "type": "string" }, "datePickerEntries": { "type": "object" }, "textareaEntries": { "type": "object" }, "optional": { "type": "number" }, "internalOnly": { "type": "number" }, "sendsEmailOnCompletion": { "type": "number" }, "causesRepContactOnCompletion": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" }, "stage": { "type": "number" }, "internalComments": { "type": "string" }, "textfieldName": { "type": "string" }, "helpDoc": { "type": "number" }, "checkboxEnabler": { "type": "string" }, "textfieldEntries": { "type": "object" }, "businessRuleGroups": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRuleGroup" } } }, "required": [ "optional", "internalOnly", "sendsEmailOnCompletion", "causesRepContactOnCompletion", "ruleGroupsAreOr" ], "additionalProperties": false, "x-typescript-type": "ProcessflowWithRelations" }, "ProcessflowPartial": { "title": "ProcessflowPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "group": { "type": "number" }, "title": { "type": "string" }, "details": { "type": "string" }, "order": { "type": "number" }, "reliesOnTrue": { "type": "number" }, "reliesOnFalse": { "type": "number" }, "inputType": { "type": "number" }, "checkboxEntries": { "type": "object" }, "fileUploadEntries": { "type": "object" }, "stateEntries": { "type": "object" }, "yesNoEntries": { "type": "string" }, "selectBoxEntries": {}, "entries": { "type": "string" }, "datePickerEntries": { "type": "object" }, "textareaEntries": { "type": "object" }, "optional": { "type": "number" }, "internalOnly": { "type": "number" }, "sendsEmailOnCompletion": { "type": "number" }, "causesRepContactOnCompletion": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" }, "stage": { "type": "number" }, "internalComments": { "type": "string" }, "textfieldName": { "type": "string" }, "helpDoc": { "type": "number" }, "checkboxEnabler": { "type": "string" }, "textfieldEntries": { "type": "object" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ProcessflowStages": { "title": "ProcessflowStages", "type": "object", "properties": { "id": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number" }, "group": { "type": "number" }, "isPublic": { "type": "number" } }, "required": [ "ruleGroupsAreOr" ], "additionalProperties": false }, "NewProcessflowStages": { "title": "NewProcessflowStages", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewProcessflowStages', exclude: [ 'id' ] })", "properties": { "ruleGroupsAreOr": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number" }, "group": { "type": "number" }, "isPublic": { "type": "number" } }, "required": [ "ruleGroupsAreOr" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ProcessflowStagesWithRelations": { "title": "ProcessflowStagesWithRelations", "type": "object", "description": "(tsType: ProcessflowStagesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number" }, "group": { "type": "number" }, "isPublic": { "type": "number" }, "businessRuleGroups": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRuleGroup" } } }, "required": [ "ruleGroupsAreOr" ], "additionalProperties": false, "x-typescript-type": "ProcessflowStagesWithRelations" }, "ProcessflowStagesPartial": { "title": "ProcessflowStagesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number" }, "group": { "type": "number" }, "isPublic": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewBusinessRuleGroupInProcessflowStages": { "title": "NewBusinessRuleGroupInProcessflowStages", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBusinessRuleGroupInProcessflowStages', exclude: [ 'id' ] })", "properties": { "description": { "type": "string" }, "isQualify": { "type": "number" }, "isAnd": { "type": "number" }, "product": { "type": "number" }, "folder": { "type": "number" }, "name": { "type": "string" } }, "required": [ "isQualify", "isAnd", "product" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BusinessRuleGroupPartial": { "title": "BusinessRuleGroupPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "isQualify": { "type": "number" }, "isAnd": { "type": "number" }, "product": { "type": "number" }, "folder": { "type": "number" }, "name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ProcessflowStageRuleGroups": { "title": "ProcessflowStageRuleGroups", "type": "object", "properties": { "id": { "type": "number" }, "businessRuleGroupId": { "type": "number" }, "stageId": { "type": "number" } }, "additionalProperties": false }, "NewProcessflowStageRuleGroups": { "title": "NewProcessflowStageRuleGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewProcessflowStageRuleGroups', exclude: [ 'id' ] })", "properties": { "businessRuleGroupId": { "type": "number" }, "stageId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ProcessflowStageRuleGroupsWithRelations": { "title": "ProcessflowStageRuleGroupsWithRelations", "type": "object", "description": "(tsType: ProcessflowStageRuleGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "businessRuleGroupId": { "type": "number" }, "stageId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "ProcessflowStageRuleGroupsWithRelations" }, "ProcessflowStageRuleGroupsPartial": { "title": "ProcessflowStageRuleGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "businessRuleGroupId": { "type": "number" }, "stageId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ProcessflowRuleGroups": { "title": "ProcessflowRuleGroups", "type": "object", "properties": { "businessRuleGroupId": { "type": "number" }, "id": { "type": "number" }, "processflowId": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" } }, "additionalProperties": false }, "NewProcessflowRuleGroups": { "title": "NewProcessflowRuleGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewProcessflowRuleGroups', exclude: [ 'id' ] })", "properties": { "businessRuleGroupId": { "type": "number" }, "processflowId": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ProcessflowRuleGroupsWithRelations": { "title": "ProcessflowRuleGroupsWithRelations", "type": "object", "description": "(tsType: ProcessflowRuleGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "businessRuleGroupId": { "type": "number" }, "id": { "type": "number" }, "processflowId": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "ProcessflowRuleGroupsWithRelations" }, "ProcessflowRuleGroupsPartial": { "title": "ProcessflowRuleGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "businessRuleGroupId": { "type": "number" }, "id": { "type": "number" }, "processflowId": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ProcessflowProgress": { "title": "ProcessflowProgress", "type": "object", "properties": { "client": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "number" }, "currentStage": { "type": "number" }, "currentStep": { "type": "number" }, "data": { "type": "string" }, "group": { "type": "number" }, "id": { "type": "number" }, "status": { "type": "string" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "userId": { "type": "string" } }, "additionalProperties": false }, "NewProcessflowProgress": { "title": "NewProcessflowProgress", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewProcessflowProgress', exclude: [ 'id' ] })", "properties": { "client": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "number" }, "currentStage": { "type": "number" }, "currentStep": { "type": "number" }, "data": { "type": "string" }, "group": { "type": "number" }, "status": { "type": "string" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "userId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ProcessflowProgressWithRelations": { "title": "ProcessflowProgressWithRelations", "type": "object", "description": "(tsType: ProcessflowProgressWithRelations, schemaOptions: { includeRelations: true })", "properties": { "client": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "number" }, "currentStage": { "type": "number" }, "currentStep": { "type": "number" }, "data": { "type": "string" }, "group": { "type": "number" }, "id": { "type": "number" }, "status": { "type": "string" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "userId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "ProcessflowProgressWithRelations" }, "ProcessflowProgressPartial": { "title": "ProcessflowProgressPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "client": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "number" }, "currentStage": { "type": "number" }, "currentStep": { "type": "number" }, "data": { "type": "string" }, "group": { "type": "number" }, "id": { "type": "number" }, "status": { "type": "string" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "userId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewProcessflowGroup": { "title": "NewProcessflowGroup", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewProcessflowGroup', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ProcessflowGroupWithRelations": { "title": "ProcessflowGroupWithRelations", "type": "object", "description": "(tsType: ProcessflowGroupWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Roles" } }, "roleGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RoleGroups" } }, "processflows": { "type": "array", "items": { "$ref": "#/components/schemas/Processflow" } } }, "additionalProperties": false, "x-typescript-type": "ProcessflowGroupWithRelations" }, "NewRolesInProcessflowGroup": { "title": "NewRolesInProcessflowGroup", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRolesInProcessflowGroup', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "roleCode": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ProcessflowGroupRoleGroups": { "title": "ProcessflowGroupRoleGroups", "type": "object", "properties": { "id": { "type": "number" }, "processflowGroupId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false }, "NewProcessflowGroupRoleGroups": { "title": "NewProcessflowGroupRoleGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewProcessflowGroupRoleGroups', exclude: [ 'id' ] })", "properties": { "processflowGroupId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ProcessflowGroupRoleGroupsWithRelations": { "title": "ProcessflowGroupRoleGroupsWithRelations", "type": "object", "description": "(tsType: ProcessflowGroupRoleGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "processflowGroupId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "ProcessflowGroupRoleGroupsWithRelations" }, "ProcessflowGroupRoleGroupsPartial": { "title": "ProcessflowGroupRoleGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "processflowGroupId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewProcessflowInProcessflowGroup": { "title": "NewProcessflowInProcessflowGroup", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'group'>, schemaOptions: { title: 'NewProcessflowInProcessflowGroup', exclude: [ 'id' ], optional: [ 'group' ] })", "properties": { "group": { "type": "number" }, "title": { "type": "string" }, "details": { "type": "string" }, "order": { "type": "number" }, "reliesOnTrue": { "type": "number" }, "reliesOnFalse": { "type": "number" }, "inputType": { "type": "number" }, "checkboxEntries": { "type": "object" }, "fileUploadEntries": { "type": "object" }, "stateEntries": { "type": "object" }, "yesNoEntries": { "type": "string" }, "selectBoxEntries": {}, "entries": { "type": "string" }, "datePickerEntries": { "type": "object" }, "textareaEntries": { "type": "object" }, "optional": { "type": "number" }, "internalOnly": { "type": "number" }, "sendsEmailOnCompletion": { "type": "number" }, "causesRepContactOnCompletion": { "type": "number" }, "ruleGroupsAreOr": { "type": "number" }, "stage": { "type": "number" }, "internalComments": { "type": "string" }, "textfieldName": { "type": "string" }, "helpDoc": { "type": "number" }, "checkboxEnabler": { "type": "string" }, "textfieldEntries": { "type": "object" } }, "required": [ "optional", "internalOnly", "sendsEmailOnCompletion", "causesRepContactOnCompletion", "ruleGroupsAreOr" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'group'>" }, "NewBusinessRuleGroupInProcessflow": { "title": "NewBusinessRuleGroupInProcessflow", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBusinessRuleGroupInProcessflow', exclude: [ 'id' ] })", "properties": { "description": { "type": "string" }, "isQualify": { "type": "number" }, "isAnd": { "type": "number" }, "product": { "type": "number" }, "folder": { "type": "number" }, "name": { "type": "string" } }, "required": [ "isQualify", "isAnd", "product" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "PayrollContact": { "title": "PayrollContact", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false }, "NewPayrollContact": { "title": "NewPayrollContact", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewPayrollContact', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "PayrollContactWithRelations": { "title": "PayrollContactWithRelations", "type": "object", "description": "(tsType: PayrollContactWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "PayrollContactWithRelations" }, "PayrollContactPartial": { "title": "PayrollContactPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "PayoutPaperworkOverrideWithRelations": { "title": "PayoutPaperworkOverrideWithRelations", "type": "object", "description": "(tsType: PayoutPaperworkOverrideWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "transactionId": { "type": "string" }, "companyId": { "type": "number" }, "userId": { "type": "string" }, "reason": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "transactionId" ], "additionalProperties": false, "x-typescript-type": "PayoutPaperworkOverrideWithRelations" }, "PaymentNew": { "title": "PaymentNew", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "sourceCompanyId": { "type": "number" }, "destinationCompanyId": { "type": "number" }, "sourceUserId": { "type": "string" }, "destinationUserId": { "type": "string" }, "amount": { "type": "number" }, "feeAmount": { "type": "number" }, "currency": { "type": "string" }, "method": { "type": "string", "enum": [ "ach", "wire", "check", "card", "stripe", "billcom", "other" ] }, "status": { "type": "string", "enum": [ "draft", "initiated", "sent", "confirmed", "returned", "voided" ] }, "initiatedAt": { "type": "string", "format": "date-time" }, "sentAt": { "type": "string", "format": "date-time" }, "sentById": { "type": "string" }, "confirmedAt": { "type": "string", "format": "date-time" }, "confirmedById": { "type": "string" }, "returnedAt": { "type": "string", "format": "date-time" }, "returnedById": { "type": "string" }, "voidedAt": { "type": "string", "format": "date-time" }, "voidedById": { "type": "string" }, "traceNumber": { "type": "string" }, "processorRef": { "type": "string" }, "memo": { "type": "string" }, "notes": { "type": "string" }, "reference": { "type": "string" }, "batchId": { "type": "string" }, "externalRef": { "type": "string" }, "reversalOfPaymentId": { "type": "string" }, "chequeNumber": { "type": "string" }, "legacySource": { "type": "string" }, "legacyId": { "type": "string" }, "importBatchId": { "type": "string" }, "sourceSnapshot": { "type": "object" } }, "required": [ "sourceCompanyId", "amount", "method", "status" ], "additionalProperties": false }, "NewPaymentNew": { "title": "NewPaymentNew", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n title: 'NewPaymentNew',\n exclude: [\n 'id', 'createdAt',\n 'updatedAt', 'createdById',\n 'initiatedAt', 'sentAt',\n 'sentById', 'confirmedById',\n 'returnedAt', 'returnedById',\n 'voidedAt', 'voidedById',\n 'legacySource', 'legacyId',\n 'importBatchId'\n ]\n})", "properties": { "sourceCompanyId": { "type": "number" }, "destinationCompanyId": { "type": "number" }, "sourceUserId": { "type": "string" }, "destinationUserId": { "type": "string" }, "amount": { "type": "number" }, "feeAmount": { "type": "number" }, "currency": { "type": "string" }, "method": { "type": "string", "enum": [ "ach", "wire", "check", "card", "stripe", "billcom", "other" ] }, "status": { "type": "string", "enum": [ "draft", "initiated", "sent", "confirmed", "returned", "voided" ] }, "confirmedAt": { "type": "string", "format": "date-time" }, "traceNumber": { "type": "string" }, "processorRef": { "type": "string" }, "memo": { "type": "string" }, "notes": { "type": "string" }, "reference": { "type": "string" }, "batchId": { "type": "string" }, "externalRef": { "type": "string" }, "reversalOfPaymentId": { "type": "string" }, "chequeNumber": { "type": "string" }, "sourceSnapshot": { "type": "object" } }, "required": [ "sourceCompanyId", "amount", "method", "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "PaymentNewWithRelations": { "title": "PaymentNewWithRelations", "type": "object", "description": "(tsType: PaymentNewWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "sourceCompanyId": { "type": "number" }, "destinationCompanyId": { "type": "number" }, "sourceUserId": { "type": "string" }, "destinationUserId": { "type": "string" }, "amount": { "type": "number" }, "feeAmount": { "type": "number" }, "currency": { "type": "string" }, "method": { "type": "string", "enum": [ "ach", "wire", "check", "card", "stripe", "billcom", "other" ] }, "status": { "type": "string", "enum": [ "draft", "initiated", "sent", "confirmed", "returned", "voided" ] }, "initiatedAt": { "type": "string", "format": "date-time" }, "sentAt": { "type": "string", "format": "date-time" }, "sentById": { "type": "string" }, "confirmedAt": { "type": "string", "format": "date-time" }, "confirmedById": { "type": "string" }, "returnedAt": { "type": "string", "format": "date-time" }, "returnedById": { "type": "string" }, "voidedAt": { "type": "string", "format": "date-time" }, "voidedById": { "type": "string" }, "traceNumber": { "type": "string" }, "processorRef": { "type": "string" }, "memo": { "type": "string" }, "notes": { "type": "string" }, "reference": { "type": "string" }, "batchId": { "type": "string" }, "externalRef": { "type": "string" }, "reversalOfPaymentId": { "type": "string" }, "chequeNumber": { "type": "string" }, "legacySource": { "type": "string" }, "legacyId": { "type": "string" }, "importBatchId": { "type": "string" }, "sourceSnapshot": { "type": "object" }, "sourceCompany": { "$ref": "#/components/schemas/Company" }, "foreignKey": {}, "destinationCompany": { "$ref": "#/components/schemas/Company" } }, "required": [ "sourceCompanyId", "amount", "method", "status" ], "additionalProperties": false, "x-typescript-type": "PaymentNewWithRelations" }, "PaymentAllocation": { "title": "PaymentAllocation", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "paymentNewId": { "type": "string" }, "transactionNewId": { "type": "string" }, "amount": { "type": "number" }, "reversedByEventId": { "type": "string" } }, "required": [ "paymentNewId", "transactionNewId", "amount" ], "additionalProperties": false }, "NewPayment": { "title": "NewPayment", "type": "object", "description": "(tsType: Payment, schemaOptions: { title: 'NewPayment' })", "properties": { "id": { "type": "string" }, "transactionId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "companyId": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "nullable": true }, "toCompanyId": { "type": "number" }, "fromCompanyId": { "type": "number" }, "toUserId": { "type": "string" }, "to": { "type": "string" }, "fromUserId": { "type": "string" }, "from": { "type": "string" }, "toClearErc": { "type": "boolean" }, "fromClearErc": { "type": "boolean" }, "reference": { "type": "string" }, "notes": { "type": "string" }, "description": { "type": "string" }, "paymentRequestId": { "type": "string" }, "lineItemId": { "type": "number" }, "invoiceId": { "type": "number" }, "stripeChargeId": { "type": "string" }, "qbPaymentId": { "type": "string" }, "type": { "type": "string" }, "quarter": { "type": "string" }, "receivedByPaymasterAt": { "type": "string", "format": "date-time" }, "chequeNumber": { "type": "string" }, "interest": { "type": "number", "nullable": true }, "taxes": { "type": "number", "nullable": true }, "forCompanyId": { "type": "number" }, "wireFee": { "type": "number", "nullable": true }, "currency": { "type": "string" }, "method": { "type": "string" }, "status": { "type": "string" }, "initiatedAt": { "type": "string", "format": "date-time" }, "confirmedAt": { "type": "string", "format": "date-time" }, "sentById": { "type": "string" }, "confirmedById": { "type": "string" }, "wireTraceNumber": { "type": "string" }, "wireMemo": { "type": "string" }, "reconciled": { "type": "boolean" }, "reconciledById": { "type": "string" }, "reconciledAt": { "type": "string", "format": "date-time" }, "externalRef": { "type": "string" }, "voidedAt": { "type": "string", "format": "date-time" }, "voidedById": { "type": "string" }, "reversalOfPaymentId": { "type": "string" }, "batchId": { "type": "string" } }, "required": [ "date" ], "additionalProperties": false, "x-typescript-type": "Payment" }, "PaymentRequest": { "title": "PaymentRequest", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "requestedPaymentDate": { "type": "string", "format": "date-time", "nullable": true }, "paymentDate": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "nullable": true }, "companyId": { "type": "number" }, "lineItemId": { "type": "number" }, "paymentCapturedById": { "type": "string" }, "toUserId": { "type": "string" }, "to": { "type": "string" }, "toCompanyId": { "type": "number" }, "fromCompanyId": { "type": "number" }, "fromUserId": { "type": "string" }, "from": { "type": "string" }, "toClearErc": { "type": "boolean" }, "fromClearErc": { "type": "boolean" }, "notes": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": false }, "Invoice": { "title": "Invoice", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "issuedAt": { "type": "string", "format": "date-time", "nullable": true }, "companyId": { "type": "number", "nullable": false }, "invoiceNumber": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "amount": { "type": "number", "nullable": true }, "stripeInvoiceId": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "stripeInvoiceUrl": { "type": "string", "nullable": true }, "paidAt": { "type": "string", "format": "date-time", "nullable": true }, "amountPaid": { "type": "number", "nullable": true }, "qbInvoiceId": { "type": "string", "nullable": true }, "qbInvoicePaymentUrl": { "type": "string", "nullable": true }, "contactFirstName": { "type": "string", "nullable": true }, "contactLastName": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true }, "contactPhone": { "type": "string", "nullable": true } }, "required": [ "companyId" ], "additionalProperties": false }, "PaymentWithRelations": { "title": "PaymentWithRelations", "type": "object", "description": "(tsType: PaymentWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string" }, "transactionId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "companyId": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "nullable": true }, "toCompanyId": { "type": "number" }, "fromCompanyId": { "type": "number" }, "toUserId": { "type": "string" }, "to": { "type": "string" }, "fromUserId": { "type": "string" }, "from": { "type": "string" }, "toClearErc": { "type": "boolean" }, "fromClearErc": { "type": "boolean" }, "reference": { "type": "string" }, "notes": { "type": "string" }, "description": { "type": "string" }, "paymentRequestId": { "type": "string" }, "lineItemId": { "type": "number" }, "invoiceId": { "type": "number" }, "stripeChargeId": { "type": "string" }, "qbPaymentId": { "type": "string" }, "type": { "type": "string" }, "quarter": { "type": "string" }, "receivedByPaymasterAt": { "type": "string", "format": "date-time" }, "chequeNumber": { "type": "string" }, "interest": { "type": "number", "nullable": true }, "taxes": { "type": "number", "nullable": true }, "forCompanyId": { "type": "number" }, "wireFee": { "type": "number", "nullable": true }, "currency": { "type": "string" }, "method": { "type": "string" }, "status": { "type": "string" }, "initiatedAt": { "type": "string", "format": "date-time" }, "confirmedAt": { "type": "string", "format": "date-time" }, "sentById": { "type": "string" }, "confirmedById": { "type": "string" }, "wireTraceNumber": { "type": "string" }, "wireMemo": { "type": "string" }, "reconciled": { "type": "boolean" }, "reconciledById": { "type": "string" }, "reconciledAt": { "type": "string", "format": "date-time" }, "externalRef": { "type": "string" }, "voidedAt": { "type": "string", "format": "date-time" }, "voidedById": { "type": "string" }, "reversalOfPaymentId": { "type": "string" }, "batchId": { "type": "string" }, "createdByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "foreignKey": {}, "company": { "$ref": "#/components/schemas/Company" }, "toCompany": { "$ref": "#/components/schemas/Company" }, "fromCompany": { "$ref": "#/components/schemas/Company" }, "toUser": { "$ref": "#/components/schemas/MarshalledUser" }, "fromUser": { "$ref": "#/components/schemas/MarshalledUser" }, "paymentRequest": { "$ref": "#/components/schemas/PaymentRequest" }, "lineItem": { "$ref": "#/components/schemas/LineItems" }, "invoice": { "$ref": "#/components/schemas/Invoice" }, "forCompany": { "$ref": "#/components/schemas/Company" }, "sentByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "confirmedByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "reconciledByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "voidedByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "reversalOfPayment": { "$ref": "#/components/schemas/Payment" } }, "required": [ "date" ], "additionalProperties": false, "x-typescript-type": "PaymentWithRelations" }, "PaymentPartial": { "title": "PaymentPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string" }, "transactionId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "companyId": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "nullable": true }, "toCompanyId": { "type": "number" }, "fromCompanyId": { "type": "number" }, "toUserId": { "type": "string" }, "to": { "type": "string" }, "fromUserId": { "type": "string" }, "from": { "type": "string" }, "toClearErc": { "type": "boolean" }, "fromClearErc": { "type": "boolean" }, "reference": { "type": "string" }, "notes": { "type": "string" }, "description": { "type": "string" }, "paymentRequestId": { "type": "string" }, "lineItemId": { "type": "number" }, "invoiceId": { "type": "number" }, "stripeChargeId": { "type": "string" }, "qbPaymentId": { "type": "string" }, "type": { "type": "string" }, "quarter": { "type": "string" }, "receivedByPaymasterAt": { "type": "string", "format": "date-time" }, "chequeNumber": { "type": "string" }, "interest": { "type": "number", "nullable": true }, "taxes": { "type": "number", "nullable": true }, "forCompanyId": { "type": "number" }, "wireFee": { "type": "number", "nullable": true }, "currency": { "type": "string" }, "method": { "type": "string" }, "status": { "type": "string" }, "initiatedAt": { "type": "string", "format": "date-time" }, "confirmedAt": { "type": "string", "format": "date-time" }, "sentById": { "type": "string" }, "confirmedById": { "type": "string" }, "wireTraceNumber": { "type": "string" }, "wireMemo": { "type": "string" }, "reconciled": { "type": "boolean" }, "reconciledById": { "type": "string" }, "reconciledAt": { "type": "string", "format": "date-time" }, "externalRef": { "type": "string" }, "voidedAt": { "type": "string", "format": "date-time" }, "voidedById": { "type": "string" }, "reversalOfPaymentId": { "type": "string" }, "batchId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "FileUploads": { "title": "FileUploads", "type": "object", "properties": { "id": { "type": "number" }, "dateUploaded": { "type": "string", "format": "date-time" }, "originalFilename": { "type": "string" }, "filename": { "type": "string" }, "key": { "type": "object" }, "isArchived": { "type": "boolean" }, "encoding": { "type": "string" }, "mimetype": { "type": "string" }, "size": { "type": "number" }, "uploaded_by": { "type": "string" }, "notes": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "tpaInvoice": { "type": "number" }, "documentTypeId": { "type": "number" }, "companyId": { "type": "number" }, "processflowProgressId": { "type": "number" }, "paymentId": { "type": "string" }, "boardTaskId": { "type": "number", "nullable": true }, "boardInline": { "type": "boolean", "nullable": true }, "educationInline": { "type": "boolean", "nullable": true }, "asanaAttachmentGid": { "type": "string", "nullable": true }, "asanaWritebackError": { "type": "string", "nullable": true }, "asanaWritebackErrorAt": { "type": "string", "format": "date-time", "nullable": true }, "asanaWritebackAbandonedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "dateUploaded" ], "additionalProperties": false }, "PaymentIntents": { "title": "PaymentIntents", "type": "object", "properties": { "id": { "type": "string" }, "details": { "type": "object", "nullable": true }, "company": { "type": "number" } }, "additionalProperties": false }, "NewPaymentIntents": { "title": "NewPaymentIntents", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewPaymentIntents', exclude: [ 'id' ] })", "properties": { "details": { "type": "object", "nullable": true }, "company": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "PaymentIntentsWithRelations": { "title": "PaymentIntentsWithRelations", "type": "object", "description": "(tsType: PaymentIntentsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string" }, "details": { "type": "object", "nullable": true }, "company": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "PaymentIntentsWithRelations" }, "PaymentIntentsPartial": { "title": "PaymentIntentsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string" }, "details": { "type": "object", "nullable": true }, "company": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "PackageSectionRules": { "title": "PackageSectionRules", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "isEnabler": { "type": "number", "nullable": false }, "helpDoc": { "type": "number", "nullable": true }, "processflow": { "type": "number", "nullable": true }, "processflowGroup": { "type": "number", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "required": [ "isEnabler" ], "additionalProperties": false }, "NewPackageSectionRules": { "title": "NewPackageSectionRules", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewPackageSectionRules', exclude: [ 'id' ] })", "properties": { "isEnabler": { "type": "number", "nullable": false }, "helpDoc": { "type": "number", "nullable": true }, "processflow": { "type": "number", "nullable": true }, "processflowGroup": { "type": "number", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "required": [ "isEnabler" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "PackageSectionRulesWithRelations": { "title": "PackageSectionRulesWithRelations", "type": "object", "description": "(tsType: PackageSectionRulesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "isEnabler": { "type": "number", "nullable": false }, "helpDoc": { "type": "number", "nullable": true }, "processflow": { "type": "number", "nullable": true }, "processflowGroup": { "type": "number", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "required": [ "isEnabler" ], "additionalProperties": false, "x-typescript-type": "PackageSectionRulesWithRelations" }, "PackageSectionRulesPartial": { "title": "PackageSectionRulesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "isEnabler": { "type": "number", "nullable": false }, "helpDoc": { "type": "number", "nullable": true }, "processflow": { "type": "number", "nullable": true }, "processflowGroup": { "type": "number", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "OutboundTask": { "title": "OutboundTask", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "assigneeUserId": { "type": "string", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "dueAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "completedVia": { "type": "string", "nullable": true }, "createdByUserId": { "type": "string", "nullable": true }, "lastNudgedAt": { "type": "string", "format": "date-time", "nullable": true }, "nudgeCount": { "type": "number" }, "channelEmail": { "type": "boolean" }, "interactionId": { "type": "number", "nullable": true }, "sweepKey": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "sourceType": { "type": "string", "nullable": true }, "sourceRuleId": { "type": "number", "nullable": true } }, "required": [ "companyId", "title" ], "additionalProperties": false }, "OutboundTaskDelegates": { "title": "OutboundTaskDelegates", "type": "object", "properties": { "id": { "type": "number" }, "taskId": { "type": "number" }, "userId": { "type": "string" }, "delegatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "taskId", "userId" ], "additionalProperties": false }, "Orders": { "title": "Orders", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "idenNum": { "type": "string", "nullable": true }, "geoType": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "orderNum": { "type": "string", "nullable": true }, "broadstreetNum": { "type": "string", "nullable": true }, "govBody": { "type": "string", "nullable": true }, "amend": { "type": "string", "nullable": true }, "startD": { "type": "string", "format": "date-time", "nullable": true }, "endD": { "type": "string", "format": "date-time", "nullable": true }, "initialEmgcy": { "type": "string", "format": "binary", "nullable": true }, "contEmgcy": { "type": "string", "format": "binary", "nullable": true }, "reopen": { "type": "string", "format": "binary", "nullable": true }, "stayHome": { "type": "string", "format": "binary", "nullable": true }, "curfew": { "type": "string", "format": "binary", "nullable": true }, "maskReq": { "type": "string", "format": "binary", "nullable": true }, "gatherBan": { "type": "string", "format": "binary", "nullable": true }, "socialDist": { "type": "string", "format": "binary", "nullable": true }, "bsns": { "type": "string", "format": "binary", "nullable": true }, "restaurant": { "type": "string", "format": "binary", "nullable": true }, "school": { "type": "string", "format": "binary", "nullable": true }, "medProc": { "type": "string", "format": "binary", "nullable": true }, "travel": { "type": "string", "format": "binary", "nullable": true }, "correcFac": { "type": "string", "format": "binary", "nullable": true }, "vaccine": { "type": "string", "format": "binary", "nullable": true }, "notes": { "type": "string", "nullable": true }, "industries": { "type": "string", "nullable": true }, "lastupdated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "NewOrders": { "title": "NewOrders", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewOrders', exclude: [ 'id' ] })", "properties": { "idenNum": { "type": "string", "nullable": true }, "geoType": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "orderNum": { "type": "string", "nullable": true }, "broadstreetNum": { "type": "string", "nullable": true }, "govBody": { "type": "string", "nullable": true }, "amend": { "type": "string", "nullable": true }, "startD": { "type": "string", "format": "date-time", "nullable": true }, "endD": { "type": "string", "format": "date-time", "nullable": true }, "initialEmgcy": { "type": "string", "format": "binary", "nullable": true }, "contEmgcy": { "type": "string", "format": "binary", "nullable": true }, "reopen": { "type": "string", "format": "binary", "nullable": true }, "stayHome": { "type": "string", "format": "binary", "nullable": true }, "curfew": { "type": "string", "format": "binary", "nullable": true }, "maskReq": { "type": "string", "format": "binary", "nullable": true }, "gatherBan": { "type": "string", "format": "binary", "nullable": true }, "socialDist": { "type": "string", "format": "binary", "nullable": true }, "bsns": { "type": "string", "format": "binary", "nullable": true }, "restaurant": { "type": "string", "format": "binary", "nullable": true }, "school": { "type": "string", "format": "binary", "nullable": true }, "medProc": { "type": "string", "format": "binary", "nullable": true }, "travel": { "type": "string", "format": "binary", "nullable": true }, "correcFac": { "type": "string", "format": "binary", "nullable": true }, "vaccine": { "type": "string", "format": "binary", "nullable": true }, "notes": { "type": "string", "nullable": true }, "industries": { "type": "string", "nullable": true }, "lastupdated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "OrdersWithRelations": { "title": "OrdersWithRelations", "type": "object", "description": "(tsType: OrdersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "idenNum": { "type": "string", "nullable": true }, "geoType": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "orderNum": { "type": "string", "nullable": true }, "broadstreetNum": { "type": "string", "nullable": true }, "govBody": { "type": "string", "nullable": true }, "amend": { "type": "string", "nullable": true }, "startD": { "type": "string", "format": "date-time", "nullable": true }, "endD": { "type": "string", "format": "date-time", "nullable": true }, "initialEmgcy": { "type": "string", "format": "binary", "nullable": true }, "contEmgcy": { "type": "string", "format": "binary", "nullable": true }, "reopen": { "type": "string", "format": "binary", "nullable": true }, "stayHome": { "type": "string", "format": "binary", "nullable": true }, "curfew": { "type": "string", "format": "binary", "nullable": true }, "maskReq": { "type": "string", "format": "binary", "nullable": true }, "gatherBan": { "type": "string", "format": "binary", "nullable": true }, "socialDist": { "type": "string", "format": "binary", "nullable": true }, "bsns": { "type": "string", "format": "binary", "nullable": true }, "restaurant": { "type": "string", "format": "binary", "nullable": true }, "school": { "type": "string", "format": "binary", "nullable": true }, "medProc": { "type": "string", "format": "binary", "nullable": true }, "travel": { "type": "string", "format": "binary", "nullable": true }, "correcFac": { "type": "string", "format": "binary", "nullable": true }, "vaccine": { "type": "string", "format": "binary", "nullable": true }, "notes": { "type": "string", "nullable": true }, "industries": { "type": "string", "nullable": true }, "lastupdated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "OrdersWithRelations" }, "OrdersPartial": { "title": "OrdersPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "idenNum": { "type": "string", "nullable": true }, "geoType": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "orderNum": { "type": "string", "nullable": true }, "broadstreetNum": { "type": "string", "nullable": true }, "govBody": { "type": "string", "nullable": true }, "amend": { "type": "string", "nullable": true }, "startD": { "type": "string", "format": "date-time", "nullable": true }, "endD": { "type": "string", "format": "date-time", "nullable": true }, "initialEmgcy": { "type": "string", "format": "binary", "nullable": true }, "contEmgcy": { "type": "string", "format": "binary", "nullable": true }, "reopen": { "type": "string", "format": "binary", "nullable": true }, "stayHome": { "type": "string", "format": "binary", "nullable": true }, "curfew": { "type": "string", "format": "binary", "nullable": true }, "maskReq": { "type": "string", "format": "binary", "nullable": true }, "gatherBan": { "type": "string", "format": "binary", "nullable": true }, "socialDist": { "type": "string", "format": "binary", "nullable": true }, "bsns": { "type": "string", "format": "binary", "nullable": true }, "restaurant": { "type": "string", "format": "binary", "nullable": true }, "school": { "type": "string", "format": "binary", "nullable": true }, "medProc": { "type": "string", "format": "binary", "nullable": true }, "travel": { "type": "string", "format": "binary", "nullable": true }, "correcFac": { "type": "string", "format": "binary", "nullable": true }, "vaccine": { "type": "string", "format": "binary", "nullable": true }, "notes": { "type": "string", "nullable": true }, "industries": { "type": "string", "nullable": true }, "lastupdated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Notification": { "title": "Notification", "type": "object", "properties": { "id": { "type": "string" }, "from": { "type": "object" }, "type": { "type": "string" }, "to": { "type": "object" }, "uniqueUrl": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" }, "templateId": { "type": "string" }, "provider": { "type": "string" }, "providerId": { "type": "string" }, "error": { "type": "string" } }, "required": [ "id", "type", "to" ], "description": "{\"indexInfo\":{\"uniqueUrl\":{\"unique\":true}}}", "additionalProperties": false }, "NewNotification": { "title": "NewNotification", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewNotification', exclude: [ 'id' ] }), {\"indexInfo\":{\"uniqueUrl\":{\"unique\":true}}}", "properties": { "from": { "type": "object" }, "type": { "type": "string" }, "to": { "type": "object" }, "uniqueUrl": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" }, "templateId": { "type": "string" }, "provider": { "type": "string" }, "providerId": { "type": "string" }, "error": { "type": "string" } }, "required": [ "type", "to" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "NotificationWithRelations": { "title": "NotificationWithRelations", "type": "object", "description": "(tsType: NotificationWithRelations, schemaOptions: { includeRelations: true }), {\"indexInfo\":{\"uniqueUrl\":{\"unique\":true}}}", "properties": { "id": { "type": "string" }, "from": { "type": "object" }, "type": { "type": "string" }, "to": { "type": "object" }, "uniqueUrl": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" }, "templateId": { "type": "string" }, "provider": { "type": "string" }, "providerId": { "type": "string" }, "error": { "type": "string" } }, "required": [ "id", "type", "to" ], "additionalProperties": false, "x-typescript-type": "NotificationWithRelations" }, "NotificationPartial": { "title": "NotificationPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true }), {\"indexInfo\":{\"uniqueUrl\":{\"unique\":true}}}", "properties": { "id": { "type": "string" }, "from": { "type": "object" }, "type": { "type": "string" }, "to": { "type": "object" }, "uniqueUrl": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" }, "templateId": { "type": "string" }, "provider": { "type": "string" }, "providerId": { "type": "string" }, "error": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Navigation": { "title": "Navigation", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "icon": { "type": "string" }, "href": { "type": "string" }, "current": { "type": "number" }, "requiredRoles": { "type": "object" }, "requiresOneRole": { "type": "object" }, "order": { "type": "number" }, "visible": { "type": "number" }, "parentId": { "type": "number" } }, "additionalProperties": false }, "NewNavigation": { "title": "NewNavigation", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewNavigation', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "href": { "type": "string" }, "current": { "type": "number" }, "requiredRoles": { "type": "object" }, "requiresOneRole": { "type": "object" }, "order": { "type": "number" }, "visible": { "type": "number" }, "parentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "NavigationWithRelations": { "title": "NavigationWithRelations", "type": "object", "description": "(tsType: NavigationWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "icon": { "type": "string" }, "href": { "type": "string" }, "current": { "type": "number" }, "requiredRoles": { "type": "object" }, "requiresOneRole": { "type": "object" }, "order": { "type": "number" }, "visible": { "type": "number" }, "parentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "NavigationWithRelations" }, "NavigationPartial": { "title": "NavigationPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "icon": { "type": "string" }, "href": { "type": "string" }, "current": { "type": "number" }, "requiredRoles": { "type": "object" }, "requiresOneRole": { "type": "object" }, "order": { "type": "number" }, "visible": { "type": "number" }, "parentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Multitenant": { "title": "Multitenant", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "url": { "type": "string", "nullable": true }, "logo": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "smallLogo": { "type": "string", "nullable": true }, "emailLogoUrl": { "type": "string", "nullable": true }, "emailLogoDarkUrl": { "type": "string", "nullable": true }, "emailSource": { "type": "string", "nullable": true }, "dashboardBaseUrl": { "type": "string", "nullable": true }, "postalAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewMultitenant": { "title": "NewMultitenant", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMultitenant', exclude: [ 'id' ] })", "properties": { "url": { "type": "string", "nullable": true }, "logo": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "smallLogo": { "type": "string", "nullable": true }, "emailLogoUrl": { "type": "string", "nullable": true }, "emailLogoDarkUrl": { "type": "string", "nullable": true }, "emailSource": { "type": "string", "nullable": true }, "dashboardBaseUrl": { "type": "string", "nullable": true }, "postalAddress": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MultitenantWithRelations": { "title": "MultitenantWithRelations", "type": "object", "description": "(tsType: MultitenantWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "url": { "type": "string", "nullable": true }, "logo": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "smallLogo": { "type": "string", "nullable": true }, "emailLogoUrl": { "type": "string", "nullable": true }, "emailLogoDarkUrl": { "type": "string", "nullable": true }, "emailSource": { "type": "string", "nullable": true }, "dashboardBaseUrl": { "type": "string", "nullable": true }, "postalAddress": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "MultitenantWithRelations" }, "MultitenantPartial": { "title": "MultitenantPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "url": { "type": "string", "nullable": true }, "logo": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "smallLogo": { "type": "string", "nullable": true }, "emailLogoUrl": { "type": "string", "nullable": true }, "emailLogoDarkUrl": { "type": "string", "nullable": true }, "emailSource": { "type": "string", "nullable": true }, "dashboardBaseUrl": { "type": "string", "nullable": true }, "postalAddress": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MondaySyncDataWithRelations": { "title": "MondaySyncDataWithRelations", "type": "object", "description": "(tsType: MondaySyncDataWithRelations, schemaOptions: { includeRelations: true })", "properties": { "clearErcId": { "type": "string" }, "ercData": { "type": "string" }, "ercLastUpdated": { "type": "string", "format": "date-time" }, "fieldId": { "type": "number" }, "id": { "type": "number" }, "mondayData": { "type": "string" }, "mondayId": { "type": "string" }, "mondayLastUpdated": { "type": "string", "format": "date-time" }, "processed": { "type": "number" } }, "required": [ "processed" ], "additionalProperties": false, "x-typescript-type": "MondaySyncDataWithRelations" }, "Mandates": { "title": "Mandates", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "aiName": { "type": "string", "nullable": true }, "aiNameFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiNameCorrect": { "type": "boolean", "nullable": true }, "aiNameAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetName": { "type": "string", "nullable": true }, "humanName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "nameNotes": { "type": "string", "nullable": true }, "feedbackOnNameUserId": { "type": "string", "nullable": true }, "aiEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "aiEffectiveDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiEffectiveDateCorrect": { "type": "boolean", "nullable": true }, "aiEffectiveDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "googleSheetDate": { "type": "string", "format": "date-time", "nullable": true }, "humanEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDateNotes": { "type": "string", "nullable": true }, "feedbackOnEffectiveDateUserId": { "type": "string", "nullable": true }, "aiUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "aiUntilDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiUntilDateCorrect": { "type": "boolean", "nullable": true }, "aiUntilDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "humanUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "untilDate": { "type": "string", "format": "date-time", "nullable": true }, "untilDateNotes": { "type": "string", "nullable": true }, "feedbackOnUntilDateUserId": { "type": "string", "nullable": true }, "googleSheetUrl": { "type": "string", "nullable": true }, "humanUrl": { "type": "string", "nullable": true }, "url": { "type": "string" }, "aiAuthority": { "type": "string", "nullable": true }, "aiAuthorityFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiAuthorityCorrect": { "type": "boolean", "nullable": true }, "aiAuthorityAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetAuthority": { "type": "string", "nullable": true }, "humanAuthority": { "type": "string", "nullable": true }, "authority": { "type": "string", "nullable": true }, "authorityNotes": { "type": "string", "nullable": true }, "feedbackOnAuthorityUserId": { "type": "string", "nullable": true }, "aiIssueDate": { "type": "string", "format": "date-time", "nullable": true }, "humanIssueDate": { "type": "string", "format": "date-time", "nullable": true }, "issueDate": { "type": "string", "format": "date-time", "nullable": true }, "googleSheetArea": { "type": "string", "nullable": true }, "aiState": { "type": "string", "nullable": true }, "aiStateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiStateCorrect": { "type": "boolean", "nullable": true }, "aiStateAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetState": { "type": "string", "nullable": true }, "humanState": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "stateNotes": { "type": "string", "nullable": true }, "feedbackOnStateUserId": { "type": "string", "nullable": true }, "processedByAiAt": { "type": "string", "format": "date-time" }, "aiVersion": { "type": "number" }, "aiIterationNumber": { "type": "number" }, "needsAiSync": { "type": "boolean" }, "status": { "type": "string" }, "error": { "type": "string" }, "counties": { "type": "array", "items": { "type": "string" } }, "aiCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCountiesFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiCountiesCorrect": { "type": "boolean", "nullable": true }, "aiCountiesAtFeedbackTime": { "type": "array", "items": { "type": "string", "nullable": true } }, "googleSheetCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "countiesNotes": { "type": "string", "nullable": true }, "feedbackOnCountiesUserId": { "type": "string", "nullable": true }, "cities": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCitiesFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiCitiesCorrect": { "type": "boolean", "nullable": true }, "aiCitiesAtFeedbackTime": { "type": "array", "items": { "type": "string", "nullable": true } }, "googleSheetCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "citiesNotes": { "type": "string", "nullable": true }, "feedbackOnCitiesUserId": { "type": "string", "nullable": true }, "aiExtendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "aiExtendedUntilDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiExtendedUntilDateCorrect": { "type": "boolean", "nullable": true }, "aiExtendedUntilDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "humanExtendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "extendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "extendedUntilDateNotes": { "type": "string", "nullable": true }, "feedbackOnExtendedUntilDateUserId": { "type": "string", "nullable": true }, "summary": { "type": "string" }, "notes": { "type": "string" }, "mandateType": { "type": "number" }, "fileId": { "type": "number" }, "orderId": { "type": "number" }, "orderText": { "type": "string" }, "key": { "type": "string" } }, "description": "{\"indexInfo\":{\"key\":{\"unique\":true}}}", "additionalProperties": false }, "NewMandates": { "title": "NewMandates", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandates', exclude: [ 'id' ] }), {\"indexInfo\":{\"key\":{\"unique\":true}}}", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "aiName": { "type": "string", "nullable": true }, "aiNameFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiNameCorrect": { "type": "boolean", "nullable": true }, "aiNameAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetName": { "type": "string", "nullable": true }, "humanName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "nameNotes": { "type": "string", "nullable": true }, "feedbackOnNameUserId": { "type": "string", "nullable": true }, "aiEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "aiEffectiveDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiEffectiveDateCorrect": { "type": "boolean", "nullable": true }, "aiEffectiveDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "googleSheetDate": { "type": "string", "format": "date-time", "nullable": true }, "humanEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDateNotes": { "type": "string", "nullable": true }, "feedbackOnEffectiveDateUserId": { "type": "string", "nullable": true }, "aiUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "aiUntilDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiUntilDateCorrect": { "type": "boolean", "nullable": true }, "aiUntilDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "humanUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "untilDate": { "type": "string", "format": "date-time", "nullable": true }, "untilDateNotes": { "type": "string", "nullable": true }, "feedbackOnUntilDateUserId": { "type": "string", "nullable": true }, "googleSheetUrl": { "type": "string", "nullable": true }, "humanUrl": { "type": "string", "nullable": true }, "url": { "type": "string" }, "aiAuthority": { "type": "string", "nullable": true }, "aiAuthorityFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiAuthorityCorrect": { "type": "boolean", "nullable": true }, "aiAuthorityAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetAuthority": { "type": "string", "nullable": true }, "humanAuthority": { "type": "string", "nullable": true }, "authority": { "type": "string", "nullable": true }, "authorityNotes": { "type": "string", "nullable": true }, "feedbackOnAuthorityUserId": { "type": "string", "nullable": true }, "aiIssueDate": { "type": "string", "format": "date-time", "nullable": true }, "humanIssueDate": { "type": "string", "format": "date-time", "nullable": true }, "issueDate": { "type": "string", "format": "date-time", "nullable": true }, "googleSheetArea": { "type": "string", "nullable": true }, "aiState": { "type": "string", "nullable": true }, "aiStateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiStateCorrect": { "type": "boolean", "nullable": true }, "aiStateAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetState": { "type": "string", "nullable": true }, "humanState": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "stateNotes": { "type": "string", "nullable": true }, "feedbackOnStateUserId": { "type": "string", "nullable": true }, "processedByAiAt": { "type": "string", "format": "date-time" }, "aiVersion": { "type": "number" }, "aiIterationNumber": { "type": "number" }, "needsAiSync": { "type": "boolean" }, "status": { "type": "string" }, "error": { "type": "string" }, "counties": { "type": "array", "items": { "type": "string" } }, "aiCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCountiesFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiCountiesCorrect": { "type": "boolean", "nullable": true }, "aiCountiesAtFeedbackTime": { "type": "array", "items": { "type": "string", "nullable": true } }, "googleSheetCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "countiesNotes": { "type": "string", "nullable": true }, "feedbackOnCountiesUserId": { "type": "string", "nullable": true }, "cities": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCitiesFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiCitiesCorrect": { "type": "boolean", "nullable": true }, "aiCitiesAtFeedbackTime": { "type": "array", "items": { "type": "string", "nullable": true } }, "googleSheetCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "citiesNotes": { "type": "string", "nullable": true }, "feedbackOnCitiesUserId": { "type": "string", "nullable": true }, "aiExtendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "aiExtendedUntilDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiExtendedUntilDateCorrect": { "type": "boolean", "nullable": true }, "aiExtendedUntilDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "humanExtendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "extendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "extendedUntilDateNotes": { "type": "string", "nullable": true }, "feedbackOnExtendedUntilDateUserId": { "type": "string", "nullable": true }, "summary": { "type": "string" }, "notes": { "type": "string" }, "mandateType": { "type": "number" }, "fileId": { "type": "number" }, "orderId": { "type": "number" }, "orderText": { "type": "string" }, "key": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandatesWithRelations": { "title": "MandatesWithRelations", "type": "object", "description": "(tsType: MandatesWithRelations, schemaOptions: { includeRelations: true }), {\"indexInfo\":{\"key\":{\"unique\":true}}}", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "aiName": { "type": "string", "nullable": true }, "aiNameFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiNameCorrect": { "type": "boolean", "nullable": true }, "aiNameAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetName": { "type": "string", "nullable": true }, "humanName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "nameNotes": { "type": "string", "nullable": true }, "feedbackOnNameUserId": { "type": "string", "nullable": true }, "aiEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "aiEffectiveDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiEffectiveDateCorrect": { "type": "boolean", "nullable": true }, "aiEffectiveDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "googleSheetDate": { "type": "string", "format": "date-time", "nullable": true }, "humanEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDateNotes": { "type": "string", "nullable": true }, "feedbackOnEffectiveDateUserId": { "type": "string", "nullable": true }, "aiUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "aiUntilDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiUntilDateCorrect": { "type": "boolean", "nullable": true }, "aiUntilDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "humanUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "untilDate": { "type": "string", "format": "date-time", "nullable": true }, "untilDateNotes": { "type": "string", "nullable": true }, "feedbackOnUntilDateUserId": { "type": "string", "nullable": true }, "googleSheetUrl": { "type": "string", "nullable": true }, "humanUrl": { "type": "string", "nullable": true }, "url": { "type": "string" }, "aiAuthority": { "type": "string", "nullable": true }, "aiAuthorityFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiAuthorityCorrect": { "type": "boolean", "nullable": true }, "aiAuthorityAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetAuthority": { "type": "string", "nullable": true }, "humanAuthority": { "type": "string", "nullable": true }, "authority": { "type": "string", "nullable": true }, "authorityNotes": { "type": "string", "nullable": true }, "feedbackOnAuthorityUserId": { "type": "string", "nullable": true }, "aiIssueDate": { "type": "string", "format": "date-time", "nullable": true }, "humanIssueDate": { "type": "string", "format": "date-time", "nullable": true }, "issueDate": { "type": "string", "format": "date-time", "nullable": true }, "googleSheetArea": { "type": "string", "nullable": true }, "aiState": { "type": "string", "nullable": true }, "aiStateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiStateCorrect": { "type": "boolean", "nullable": true }, "aiStateAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetState": { "type": "string", "nullable": true }, "humanState": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "stateNotes": { "type": "string", "nullable": true }, "feedbackOnStateUserId": { "type": "string", "nullable": true }, "processedByAiAt": { "type": "string", "format": "date-time" }, "aiVersion": { "type": "number" }, "aiIterationNumber": { "type": "number" }, "needsAiSync": { "type": "boolean" }, "status": { "type": "string" }, "error": { "type": "string" }, "counties": { "type": "array", "items": { "type": "string" } }, "aiCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCountiesFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiCountiesCorrect": { "type": "boolean", "nullable": true }, "aiCountiesAtFeedbackTime": { "type": "array", "items": { "type": "string", "nullable": true } }, "googleSheetCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "countiesNotes": { "type": "string", "nullable": true }, "feedbackOnCountiesUserId": { "type": "string", "nullable": true }, "cities": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCitiesFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiCitiesCorrect": { "type": "boolean", "nullable": true }, "aiCitiesAtFeedbackTime": { "type": "array", "items": { "type": "string", "nullable": true } }, "googleSheetCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "citiesNotes": { "type": "string", "nullable": true }, "feedbackOnCitiesUserId": { "type": "string", "nullable": true }, "aiExtendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "aiExtendedUntilDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiExtendedUntilDateCorrect": { "type": "boolean", "nullable": true }, "aiExtendedUntilDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "humanExtendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "extendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "extendedUntilDateNotes": { "type": "string", "nullable": true }, "feedbackOnExtendedUntilDateUserId": { "type": "string", "nullable": true }, "summary": { "type": "string" }, "notes": { "type": "string" }, "mandateType": { "type": "number" }, "fileId": { "type": "number" }, "orderId": { "type": "number" }, "orderText": { "type": "string" }, "key": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "MandatesWithRelations" }, "MandatesPartial": { "title": "MandatesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true }), {\"indexInfo\":{\"key\":{\"unique\":true}}}", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "aiName": { "type": "string", "nullable": true }, "aiNameFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiNameCorrect": { "type": "boolean", "nullable": true }, "aiNameAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetName": { "type": "string", "nullable": true }, "humanName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "nameNotes": { "type": "string", "nullable": true }, "feedbackOnNameUserId": { "type": "string", "nullable": true }, "aiEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "aiEffectiveDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiEffectiveDateCorrect": { "type": "boolean", "nullable": true }, "aiEffectiveDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "googleSheetDate": { "type": "string", "format": "date-time", "nullable": true }, "humanEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDateNotes": { "type": "string", "nullable": true }, "feedbackOnEffectiveDateUserId": { "type": "string", "nullable": true }, "aiUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "aiUntilDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiUntilDateCorrect": { "type": "boolean", "nullable": true }, "aiUntilDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "humanUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "untilDate": { "type": "string", "format": "date-time", "nullable": true }, "untilDateNotes": { "type": "string", "nullable": true }, "feedbackOnUntilDateUserId": { "type": "string", "nullable": true }, "googleSheetUrl": { "type": "string", "nullable": true }, "humanUrl": { "type": "string", "nullable": true }, "url": { "type": "string" }, "aiAuthority": { "type": "string", "nullable": true }, "aiAuthorityFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiAuthorityCorrect": { "type": "boolean", "nullable": true }, "aiAuthorityAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetAuthority": { "type": "string", "nullable": true }, "humanAuthority": { "type": "string", "nullable": true }, "authority": { "type": "string", "nullable": true }, "authorityNotes": { "type": "string", "nullable": true }, "feedbackOnAuthorityUserId": { "type": "string", "nullable": true }, "aiIssueDate": { "type": "string", "format": "date-time", "nullable": true }, "humanIssueDate": { "type": "string", "format": "date-time", "nullable": true }, "issueDate": { "type": "string", "format": "date-time", "nullable": true }, "googleSheetArea": { "type": "string", "nullable": true }, "aiState": { "type": "string", "nullable": true }, "aiStateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiStateCorrect": { "type": "boolean", "nullable": true }, "aiStateAtFeedbackTime": { "type": "string", "nullable": true }, "googleSheetState": { "type": "string", "nullable": true }, "humanState": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "stateNotes": { "type": "string", "nullable": true }, "feedbackOnStateUserId": { "type": "string", "nullable": true }, "processedByAiAt": { "type": "string", "format": "date-time" }, "aiVersion": { "type": "number" }, "aiIterationNumber": { "type": "number" }, "needsAiSync": { "type": "boolean" }, "status": { "type": "string" }, "error": { "type": "string" }, "counties": { "type": "array", "items": { "type": "string" } }, "aiCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCountiesFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiCountiesCorrect": { "type": "boolean", "nullable": true }, "aiCountiesAtFeedbackTime": { "type": "array", "items": { "type": "string", "nullable": true } }, "googleSheetCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanCounties": { "type": "array", "items": { "type": "string", "nullable": true } }, "countiesNotes": { "type": "string", "nullable": true }, "feedbackOnCountiesUserId": { "type": "string", "nullable": true }, "cities": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiCitiesFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiCitiesCorrect": { "type": "boolean", "nullable": true }, "aiCitiesAtFeedbackTime": { "type": "array", "items": { "type": "string", "nullable": true } }, "googleSheetCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanCities": { "type": "array", "items": { "type": "string", "nullable": true } }, "citiesNotes": { "type": "string", "nullable": true }, "feedbackOnCitiesUserId": { "type": "string", "nullable": true }, "aiExtendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "aiExtendedUntilDateFeedbackSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "isAiExtendedUntilDateCorrect": { "type": "boolean", "nullable": true }, "aiExtendedUntilDateAtFeedbackTime": { "type": "string", "format": "date-time", "nullable": true }, "humanExtendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "extendedUntilDate": { "type": "string", "format": "date-time", "nullable": true }, "extendedUntilDateNotes": { "type": "string", "nullable": true }, "feedbackOnExtendedUntilDateUserId": { "type": "string", "nullable": true }, "summary": { "type": "string" }, "notes": { "type": "string" }, "mandateType": { "type": "number" }, "fileId": { "type": "number" }, "orderId": { "type": "number" }, "orderText": { "type": "string" }, "key": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateTypes": { "title": "MandateTypes", "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "legallyBinding": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewMandateTypes": { "title": "NewMandateTypes", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateTypes', exclude: [ 'id' ] })", "properties": { "description": { "type": "string", "nullable": true }, "legallyBinding": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateTypesWithRelations": { "title": "MandateTypesWithRelations", "type": "object", "description": "(tsType: MandateTypesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "legallyBinding": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "MandateTypesWithRelations" }, "MandateTypesPartial": { "title": "MandateTypesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "legallyBinding": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateParagraphIndustries": { "title": "MandateParagraphIndustries", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "industry": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "paragraph": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewMandateParagraphIndustries": { "title": "NewMandateParagraphIndustries", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateParagraphIndustries', exclude: [ 'id' ] })", "properties": { "industry": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "paragraph": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateParagraphIndustriesWithRelations": { "title": "MandateParagraphIndustriesWithRelations", "type": "object", "description": "(tsType: MandateParagraphIndustriesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "industry": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "paragraph": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "MandateParagraphIndustriesWithRelations" }, "MandateParagraphIndustriesPartial": { "title": "MandateParagraphIndustriesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "industry": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "paragraph": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateParagraphIndustryGroups": { "title": "MandateParagraphIndustryGroups", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "industryGroup": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "paragraph": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewMandateParagraphIndustryGroups": { "title": "NewMandateParagraphIndustryGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateParagraphIndustryGroups', exclude: [ 'id' ] })", "properties": { "industryGroup": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "paragraph": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateParagraphIndustryGroupsWithRelations": { "title": "MandateParagraphIndustryGroupsWithRelations", "type": "object", "description": "(tsType: MandateParagraphIndustryGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "industryGroup": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "paragraph": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "MandateParagraphIndustryGroupsWithRelations" }, "MandateParagraphIndustryGroupsPartial": { "title": "MandateParagraphIndustryGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "industryGroup": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "paragraph": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateMandateEffect": { "title": "MandateMandateEffect", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "mandateId": { "type": "number" }, "createdByUserId": { "type": "string" }, "feedbackByUserId": { "type": "string" }, "mandateEffectId": { "type": "number" }, "confidence": { "type": "number", "nullable": true }, "description": { "type": "string", "nullable": true }, "aiDescription": { "type": "string", "nullable": true }, "humanDescription": { "type": "string", "nullable": true }, "impact": { "type": "string", "nullable": true }, "aiImpact": { "type": "string", "nullable": true }, "humanImpact": { "type": "string", "nullable": true }, "incorrectReason": { "type": "string", "nullable": true }, "references": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiReferences": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanReferences": { "type": "array", "items": { "type": "string", "nullable": true } }, "createdBy": { "type": "string", "nullable": true }, "doesActuallyApply": { "type": "boolean", "nullable": true }, "archivedAt": { "type": "string", "format": "date-time", "nullable": true }, "reasonArchived": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "aiVersion": { "type": "number" }, "aiIterationNumber": { "type": "number", "nullable": true } }, "required": [ "mandateId", "mandateEffectId" ], "additionalProperties": false }, "NewMandateMandateEffects": { "title": "NewMandateMandateEffects", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateMandateEffects', exclude: [ 'id' ] })", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "mandateId": { "type": "number" }, "createdByUserId": { "type": "string" }, "feedbackByUserId": { "type": "string" }, "mandateEffectId": { "type": "number" }, "confidence": { "type": "number", "nullable": true }, "description": { "type": "string", "nullable": true }, "aiDescription": { "type": "string", "nullable": true }, "humanDescription": { "type": "string", "nullable": true }, "impact": { "type": "string", "nullable": true }, "aiImpact": { "type": "string", "nullable": true }, "humanImpact": { "type": "string", "nullable": true }, "incorrectReason": { "type": "string", "nullable": true }, "references": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiReferences": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanReferences": { "type": "array", "items": { "type": "string", "nullable": true } }, "createdBy": { "type": "string", "nullable": true }, "doesActuallyApply": { "type": "boolean", "nullable": true }, "archivedAt": { "type": "string", "format": "date-time", "nullable": true }, "reasonArchived": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "aiVersion": { "type": "number" }, "aiIterationNumber": { "type": "number", "nullable": true } }, "required": [ "mandateId", "mandateEffectId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateMandateEffectWithRelations": { "title": "MandateMandateEffectWithRelations", "type": "object", "description": "(tsType: MandateMandateEffectWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "mandateId": { "type": "number" }, "createdByUserId": { "type": "string" }, "feedbackByUserId": { "type": "string" }, "mandateEffectId": { "type": "number" }, "confidence": { "type": "number", "nullable": true }, "description": { "type": "string", "nullable": true }, "aiDescription": { "type": "string", "nullable": true }, "humanDescription": { "type": "string", "nullable": true }, "impact": { "type": "string", "nullable": true }, "aiImpact": { "type": "string", "nullable": true }, "humanImpact": { "type": "string", "nullable": true }, "incorrectReason": { "type": "string", "nullable": true }, "references": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiReferences": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanReferences": { "type": "array", "items": { "type": "string", "nullable": true } }, "createdBy": { "type": "string", "nullable": true }, "doesActuallyApply": { "type": "boolean", "nullable": true }, "archivedAt": { "type": "string", "format": "date-time", "nullable": true }, "reasonArchived": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "aiVersion": { "type": "number" }, "aiIterationNumber": { "type": "number", "nullable": true }, "mandate": { "$ref": "#/components/schemas/Mandates" }, "foreignKey": {}, "createdByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "feedbackByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "mandateEffect": { "$ref": "#/components/schemas/Mandates" } }, "required": [ "mandateId", "mandateEffectId" ], "additionalProperties": false, "x-typescript-type": "MandateMandateEffectWithRelations" }, "MandateMandateEffectPartial": { "title": "MandateMandateEffectPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "mandateId": { "type": "number" }, "createdByUserId": { "type": "string" }, "feedbackByUserId": { "type": "string" }, "mandateEffectId": { "type": "number" }, "confidence": { "type": "number", "nullable": true }, "description": { "type": "string", "nullable": true }, "aiDescription": { "type": "string", "nullable": true }, "humanDescription": { "type": "string", "nullable": true }, "impact": { "type": "string", "nullable": true }, "aiImpact": { "type": "string", "nullable": true }, "humanImpact": { "type": "string", "nullable": true }, "incorrectReason": { "type": "string", "nullable": true }, "references": { "type": "array", "items": { "type": "string", "nullable": true } }, "aiReferences": { "type": "array", "items": { "type": "string", "nullable": true } }, "humanReferences": { "type": "array", "items": { "type": "string", "nullable": true } }, "createdBy": { "type": "string", "nullable": true }, "doesActuallyApply": { "type": "boolean", "nullable": true }, "archivedAt": { "type": "string", "format": "date-time", "nullable": true }, "reasonArchived": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "aiVersion": { "type": "number" }, "aiIterationNumber": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateIndustryGroups": { "title": "MandateIndustryGroups", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "reason": { "type": "string", "nullable": true }, "mandateId": { "type": "number" }, "mandateMandateEffectId": { "type": "number" }, "industryGroupId": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewMandateIndustryGroups": { "title": "NewMandateIndustryGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateIndustryGroups', exclude: [ 'id' ] })", "properties": { "reason": { "type": "string", "nullable": true }, "mandateId": { "type": "number" }, "mandateMandateEffectId": { "type": "number" }, "industryGroupId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateIndustryGroupsWithRelations": { "title": "MandateIndustryGroupsWithRelations", "type": "object", "description": "(tsType: MandateIndustryGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "reason": { "type": "string", "nullable": true }, "mandateId": { "type": "number" }, "mandateMandateEffectId": { "type": "number" }, "industryGroupId": { "type": "number", "nullable": true }, "mandate": { "$ref": "#/components/schemas/Mandates" }, "foreignKey": {}, "mandateMandateEffect": { "$ref": "#/components/schemas/MandateMandateEffect" } }, "additionalProperties": false, "x-typescript-type": "MandateIndustryGroupsWithRelations" }, "MandateIndustryGroupsPartial": { "title": "MandateIndustryGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "reason": { "type": "string", "nullable": true }, "mandateId": { "type": "number" }, "mandateMandateEffectId": { "type": "number" }, "industryGroupId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateIndustries": { "title": "MandateIndustries", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "industry": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewMandateIndustries": { "title": "NewMandateIndustries", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateIndustries', exclude: [ 'id' ] })", "properties": { "industry": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateIndustriesWithRelations": { "title": "MandateIndustriesWithRelations", "type": "object", "description": "(tsType: MandateIndustriesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "industry": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "MandateIndustriesWithRelations" }, "MandateIndustriesPartial": { "title": "MandateIndustriesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "industry": { "type": "number", "nullable": true }, "mandate": { "type": "number", "nullable": true }, "effect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateEffects": { "title": "MandateEffects", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": true }, "alternativeTerms": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewMandateEffects": { "title": "NewMandateEffects", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateEffects', exclude: [ 'id' ] })", "properties": { "name": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": true }, "alternativeTerms": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateEffectsWithRelations": { "title": "MandateEffectsWithRelations", "type": "object", "description": "(tsType: MandateEffectsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": true }, "alternativeTerms": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "MandateEffectsWithRelations" }, "MandateEffectsPartial": { "title": "MandateEffectsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": true }, "alternativeTerms": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateEffectIndustry": { "title": "MandateEffectIndustry", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "effect": { "type": "number", "nullable": true }, "industry": { "type": "number", "nullable": true }, "causesRevReduction": { "type": "number", "nullable": true }, "isApproved": { "type": "number", "nullable": true }, "isPublic": { "type": "number", "nullable": true }, "effectedHoursOfOperation": { "type": "number", "nullable": true }, "potentialRevenueLost": { "type": "number", "nullable": true }, "effectTitle": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "effectDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewMandateEffectIndustry": { "title": "NewMandateEffectIndustry", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateEffectIndustry', exclude: [ 'id' ] })", "properties": { "effect": { "type": "number", "nullable": true }, "industry": { "type": "number", "nullable": true }, "causesRevReduction": { "type": "number", "nullable": true }, "isApproved": { "type": "number", "nullable": true }, "isPublic": { "type": "number", "nullable": true }, "effectedHoursOfOperation": { "type": "number", "nullable": true }, "potentialRevenueLost": { "type": "number", "nullable": true }, "effectTitle": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "effectDescription": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateEffectIndustryWithRelations": { "title": "MandateEffectIndustryWithRelations", "type": "object", "description": "(tsType: MandateEffectIndustryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "effect": { "type": "number", "nullable": true }, "industry": { "type": "number", "nullable": true }, "causesRevReduction": { "type": "number", "nullable": true }, "isApproved": { "type": "number", "nullable": true }, "isPublic": { "type": "number", "nullable": true }, "effectedHoursOfOperation": { "type": "number", "nullable": true }, "potentialRevenueLost": { "type": "number", "nullable": true }, "effectTitle": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "effectDescription": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "MandateEffectIndustryWithRelations" }, "MandateEffectIndustryPartial": { "title": "MandateEffectIndustryPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "effect": { "type": "number", "nullable": true }, "industry": { "type": "number", "nullable": true }, "causesRevReduction": { "type": "number", "nullable": true }, "isApproved": { "type": "number", "nullable": true }, "isPublic": { "type": "number", "nullable": true }, "effectedHoursOfOperation": { "type": "number", "nullable": true }, "potentialRevenueLost": { "type": "number", "nullable": true }, "effectTitle": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "effectDescription": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateEffectIndustryGroup": { "title": "MandateEffectIndustryGroup", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "effect": { "type": "number", "nullable": true }, "industryGroup": { "type": "number", "nullable": true }, "causesRevReduction": { "type": "number", "nullable": true }, "effectedHoursOfOperation": { "type": "number", "nullable": true }, "potentialRevenueLost": { "type": "number", "nullable": true }, "isApproved": { "type": "number", "nullable": true }, "isPublic": { "type": "number", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "effectTitle": { "type": "string", "nullable": true }, "effectDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewMandateEffectIndustryGroup": { "title": "NewMandateEffectIndustryGroup", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateEffectIndustryGroup', exclude: [ 'id' ] })", "properties": { "effect": { "type": "number", "nullable": true }, "industryGroup": { "type": "number", "nullable": true }, "causesRevReduction": { "type": "number", "nullable": true }, "effectedHoursOfOperation": { "type": "number", "nullable": true }, "potentialRevenueLost": { "type": "number", "nullable": true }, "isApproved": { "type": "number", "nullable": true }, "isPublic": { "type": "number", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "effectTitle": { "type": "string", "nullable": true }, "effectDescription": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateEffectIndustryGroupWithRelations": { "title": "MandateEffectIndustryGroupWithRelations", "type": "object", "description": "(tsType: MandateEffectIndustryGroupWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "effect": { "type": "number", "nullable": true }, "industryGroup": { "type": "number", "nullable": true }, "causesRevReduction": { "type": "number", "nullable": true }, "effectedHoursOfOperation": { "type": "number", "nullable": true }, "potentialRevenueLost": { "type": "number", "nullable": true }, "isApproved": { "type": "number", "nullable": true }, "isPublic": { "type": "number", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "effectTitle": { "type": "string", "nullable": true }, "effectDescription": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "MandateEffectIndustryGroupWithRelations" }, "MandateEffectIndustryGroupPartial": { "title": "MandateEffectIndustryGroupPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "effect": { "type": "number", "nullable": true }, "industryGroup": { "type": "number", "nullable": true }, "causesRevReduction": { "type": "number", "nullable": true }, "effectedHoursOfOperation": { "type": "number", "nullable": true }, "potentialRevenueLost": { "type": "number", "nullable": true }, "isApproved": { "type": "number", "nullable": true }, "isPublic": { "type": "number", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "effectTitle": { "type": "string", "nullable": true }, "effectDescription": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateEffectGroups": { "title": "MandateEffectGroups", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewMandateEffectGroups": { "title": "NewMandateEffectGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateEffectGroups', exclude: [ 'id' ] })", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateEffectGroupsWithRelations": { "title": "MandateEffectGroupsWithRelations", "type": "object", "description": "(tsType: MandateEffectGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "MandateEffectGroupsWithRelations" }, "MandateEffectGroupsPartial": { "title": "MandateEffectGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateEffectGroupEntries": { "title": "MandateEffectGroupEntries", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "mandateEffectGroup": { "type": "number", "nullable": true }, "mandateEffect": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewMandateEffectGroupEntries": { "title": "NewMandateEffectGroupEntries", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateEffectGroupEntries', exclude: [ 'id' ] })", "properties": { "mandateEffectGroup": { "type": "number", "nullable": true }, "mandateEffect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateEffectGroupEntriesWithRelations": { "title": "MandateEffectGroupEntriesWithRelations", "type": "object", "description": "(tsType: MandateEffectGroupEntriesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "mandateEffectGroup": { "type": "number", "nullable": true }, "mandateEffect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "MandateEffectGroupEntriesWithRelations" }, "MandateEffectGroupEntriesPartial": { "title": "MandateEffectGroupEntriesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "mandateEffectGroup": { "type": "number", "nullable": true }, "mandateEffect": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MandateBinds": { "title": "MandateBinds", "type": "object", "properties": { "binds": { "type": "number", "nullable": true }, "boundBy": { "type": "number", "nullable": true }, "id": { "type": "number", "nullable": false } }, "additionalProperties": false }, "NewMandateBinds": { "title": "NewMandateBinds", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMandateBinds', exclude: [ 'id' ] })", "properties": { "binds": { "type": "number", "nullable": true }, "boundBy": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MandateBindsWithRelations": { "title": "MandateBindsWithRelations", "type": "object", "description": "(tsType: MandateBindsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "binds": { "type": "number", "nullable": true }, "boundBy": { "type": "number", "nullable": true }, "id": { "type": "number", "nullable": false } }, "additionalProperties": false, "x-typescript-type": "MandateBindsWithRelations" }, "MandateBindsPartial": { "title": "MandateBindsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "binds": { "type": "number", "nullable": true }, "boundBy": { "type": "number", "nullable": true }, "id": { "type": "number", "nullable": false } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "MagicLink": { "title": "MagicLink", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "usedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "data": { "type": "object" }, "options": { "type": "object" }, "code": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "dobAttempts": { "type": "number" }, "dobVerifiedAt": { "type": "string", "format": "date-time" }, "invalidatedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "type", "data", "code" ], "description": "{\"indexInfo\":{\"code\":{\"unique\":true}}}", "additionalProperties": false }, "NewMagicLink": { "title": "NewMagicLink", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, schemaOptions: { title: 'NewMagicLink', optional: [ 'code', 'id' ] }), {\"indexInfo\":{\"code\":{\"unique\":true}}}", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "usedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "data": { "type": "object" }, "options": { "type": "object" }, "code": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "dobAttempts": { "type": "number" }, "dobVerifiedAt": { "type": "string", "format": "date-time" }, "invalidatedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "data" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional" }, "MagicLinkWithRelations": { "title": "MagicLinkWithRelations", "type": "object", "description": "(tsType: MagicLinkWithRelations, schemaOptions: { includeRelations: true }), {\"indexInfo\":{\"code\":{\"unique\":true}}}", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "usedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "data": { "type": "object" }, "options": { "type": "object" }, "code": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "dobAttempts": { "type": "number" }, "dobVerifiedAt": { "type": "string", "format": "date-time" }, "invalidatedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "createdByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "foreignKey": {} }, "required": [ "id", "type", "data", "code" ], "additionalProperties": false, "x-typescript-type": "MagicLinkWithRelations" }, "MagicLinkPartial": { "title": "MagicLinkPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true }), {\"indexInfo\":{\"code\":{\"unique\":true}}}", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "usedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "data": { "type": "object" }, "options": { "type": "object" }, "code": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "dobAttempts": { "type": "number" }, "dobVerifiedAt": { "type": "string", "format": "date-time" }, "invalidatedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Log": { "title": "Log", "type": "object", "properties": { "body": { "type": "string" }, "eventTimestamp": { "type": "string", "format": "date-time" }, "executionTime": { "type": "number" }, "id": { "type": "number" }, "remoteIp": { "type": "string" }, "url": { "type": "string" }, "userId": { "type": "string" }, "entity": { "type": "string" }, "entityId": { "type": "string" }, "action": { "type": "string" }, "interceptorExtraDetails": { "type": "object" } }, "additionalProperties": false }, "NewLog": { "title": "NewLog", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewLog', exclude: [ 'id' ] })", "properties": { "body": { "type": "string" }, "eventTimestamp": { "type": "string", "format": "date-time" }, "executionTime": { "type": "number" }, "remoteIp": { "type": "string" }, "url": { "type": "string" }, "userId": { "type": "string" }, "entity": { "type": "string" }, "entityId": { "type": "string" }, "action": { "type": "string" }, "interceptorExtraDetails": { "type": "object" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "LogWithRelations": { "title": "LogWithRelations", "type": "object", "description": "(tsType: LogWithRelations, schemaOptions: { includeRelations: true })", "properties": { "body": { "type": "string" }, "eventTimestamp": { "type": "string", "format": "date-time" }, "executionTime": { "type": "number" }, "id": { "type": "number" }, "remoteIp": { "type": "string" }, "url": { "type": "string" }, "userId": { "type": "string" }, "entity": { "type": "string" }, "entityId": { "type": "string" }, "action": { "type": "string" }, "interceptorExtraDetails": { "type": "object" } }, "additionalProperties": false, "x-typescript-type": "LogWithRelations" }, "LogPartial": { "title": "LogPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "body": { "type": "string" }, "eventTimestamp": { "type": "string", "format": "date-time" }, "executionTime": { "type": "number" }, "id": { "type": "number" }, "remoteIp": { "type": "string" }, "url": { "type": "string" }, "userId": { "type": "string" }, "entity": { "type": "string" }, "entityId": { "type": "string" }, "action": { "type": "string" }, "interceptorExtraDetails": { "type": "object" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Interactions": { "title": "Interactions", "type": "object", "properties": { "activity": { "type": "string", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "followupDatetime": { "type": "string", "format": "date-time", "nullable": true }, "followupReminderLeadMinutes": { "type": "number", "nullable": true }, "aiSummary": { "type": "string", "nullable": true }, "aiSummaryHash": { "type": "string", "nullable": true }, "aiSummaryAt": { "type": "string", "nullable": true }, "aiSummaryError": { "type": "string", "nullable": true }, "aiSummaryAttempts": { "type": "number", "nullable": true }, "id": { "type": "number", "nullable": false }, "interactionFrom": { "type": "string", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "interactionRegarding": { "type": "string", "nullable": true }, "interactionTo": { "type": "string", "nullable": true }, "isInternal": { "type": "number", "nullable": true }, "needsFollowUp": { "type": "number", "nullable": true }, "read": { "type": "number", "nullable": true }, "summary": { "type": "string", "nullable": true }, "type": { "type": "number", "nullable": true }, "visibleByAffiliate": { "type": "number", "nullable": true }, "visibleByCpa": { "type": "number", "nullable": true }, "deleted": { "type": "number", "nullable": true }, "visibleByPaymaster": { "type": "number", "nullable": true }, "visibleBySuperUser": { "type": "number", "nullable": true }, "visibleByTaxAttorney": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewInteractions": { "title": "NewInteractions", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewInteractions', exclude: [ 'id', 'aiSummary', 'aiSummaryHash', 'aiSummaryAt', 'aiSummaryError', 'aiSummaryAttempts', 'deleted', 'deletedBy' ] })", "properties": { "activity": { "type": "string", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "followupDatetime": { "type": "string", "format": "date-time", "nullable": true }, "followupReminderLeadMinutes": { "type": "number", "nullable": true }, "interactionFrom": { "type": "string", "nullable": true }, "interactionRegarding": { "type": "string", "nullable": true }, "interactionTo": { "type": "string", "nullable": true }, "isInternal": { "type": "number", "nullable": true }, "needsFollowUp": { "type": "number", "nullable": true }, "read": { "type": "number", "nullable": true }, "summary": { "type": "string", "nullable": true }, "type": { "type": "number", "nullable": true }, "visibleByAffiliate": { "type": "number", "nullable": true }, "visibleByCpa": { "type": "number", "nullable": true }, "visibleByPaymaster": { "type": "number", "nullable": true }, "visibleBySuperUser": { "type": "number", "nullable": true }, "visibleByTaxAttorney": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "InteractionsWithRelations": { "title": "InteractionsWithRelations", "type": "object", "description": "(tsType: InteractionsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "activity": { "type": "string", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "followupDatetime": { "type": "string", "format": "date-time", "nullable": true }, "followupReminderLeadMinutes": { "type": "number", "nullable": true }, "aiSummary": { "type": "string", "nullable": true }, "aiSummaryHash": { "type": "string", "nullable": true }, "aiSummaryAt": { "type": "string", "nullable": true }, "aiSummaryError": { "type": "string", "nullable": true }, "aiSummaryAttempts": { "type": "number", "nullable": true }, "id": { "type": "number", "nullable": false }, "interactionFrom": { "type": "string", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "interactionRegarding": { "type": "string", "nullable": true }, "interactionTo": { "type": "string", "nullable": true }, "isInternal": { "type": "number", "nullable": true }, "needsFollowUp": { "type": "number", "nullable": true }, "read": { "type": "number", "nullable": true }, "summary": { "type": "string", "nullable": true }, "type": { "type": "number", "nullable": true }, "visibleByAffiliate": { "type": "number", "nullable": true }, "visibleByCpa": { "type": "number", "nullable": true }, "deleted": { "type": "number", "nullable": true }, "visibleByPaymaster": { "type": "number", "nullable": true }, "visibleBySuperUser": { "type": "number", "nullable": true }, "visibleByTaxAttorney": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "InteractionsWithRelations" }, "InteractionsPartial": { "title": "InteractionsPartial", "type": "object", "description": "(tsType: Omit, 'aiSummary' | 'aiSummaryHash' | 'aiSummaryAt' | 'aiSummaryError' | 'aiSummaryAttempts'>, schemaOptions: { partial: true, title: 'InteractionsPartial', exclude: [ 'aiSummary', 'aiSummaryHash', 'aiSummaryAt', 'aiSummaryError', 'aiSummaryAttempts' ] })", "properties": { "activity": { "type": "string", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "followupDatetime": { "type": "string", "format": "date-time", "nullable": true }, "followupReminderLeadMinutes": { "type": "number", "nullable": true }, "id": { "type": "number", "nullable": false }, "interactionFrom": { "type": "string", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "interactionRegarding": { "type": "string", "nullable": true }, "interactionTo": { "type": "string", "nullable": true }, "isInternal": { "type": "number", "nullable": true }, "needsFollowUp": { "type": "number", "nullable": true }, "read": { "type": "number", "nullable": true }, "summary": { "type": "string", "nullable": true }, "type": { "type": "number", "nullable": true }, "visibleByAffiliate": { "type": "number", "nullable": true }, "visibleByCpa": { "type": "number", "nullable": true }, "deleted": { "type": "number", "nullable": true }, "visibleByPaymaster": { "type": "number", "nullable": true }, "visibleBySuperUser": { "type": "number", "nullable": true }, "visibleByTaxAttorney": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit, 'aiSummary' | 'aiSummaryHash' | 'aiSummaryAt' | 'aiSummaryError' | 'aiSummaryAttempts'>" }, "InteractionsPatchById": { "title": "InteractionsPatchById", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true, title: 'InteractionsPatchById' })", "properties": { "activity": { "type": "string", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "followupDatetime": { "type": "string", "format": "date-time", "nullable": true }, "followupReminderLeadMinutes": { "type": "number", "nullable": true }, "aiSummary": { "type": "string", "nullable": true }, "aiSummaryHash": { "type": "string", "nullable": true }, "aiSummaryAt": { "type": "string", "nullable": true }, "aiSummaryError": { "type": "string", "nullable": true }, "aiSummaryAttempts": { "type": "number", "nullable": true }, "id": { "type": "number", "nullable": false }, "interactionFrom": { "type": "string", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "interactionRegarding": { "type": "string", "nullable": true }, "interactionTo": { "type": "string", "nullable": true }, "isInternal": { "type": "number", "nullable": true }, "needsFollowUp": { "type": "number", "nullable": true }, "read": { "type": "number", "nullable": true }, "summary": { "type": "string", "nullable": true }, "type": { "type": "number", "nullable": true }, "visibleByAffiliate": { "type": "number", "nullable": true }, "visibleByCpa": { "type": "number", "nullable": true }, "deleted": { "type": "number", "nullable": true }, "visibleByPaymaster": { "type": "number", "nullable": true }, "visibleBySuperUser": { "type": "number", "nullable": true }, "visibleByTaxAttorney": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "InteractionTypes": { "title": "InteractionTypes", "type": "object", "properties": { "customerViewable": { "type": "number" }, "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "customerViewable" ], "additionalProperties": false }, "NewInteractionTypes": { "title": "NewInteractionTypes", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewInteractionTypes', exclude: [ 'id' ] })", "properties": { "customerViewable": { "type": "number" }, "name": { "type": "string" } }, "required": [ "customerViewable" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "InteractionTypesWithRelations": { "title": "InteractionTypesWithRelations", "type": "object", "description": "(tsType: InteractionTypesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "customerViewable": { "type": "number" }, "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "customerViewable" ], "additionalProperties": false, "x-typescript-type": "InteractionTypesWithRelations" }, "InteractionTypesPartial": { "title": "InteractionTypesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "customerViewable": { "type": "number" }, "id": { "type": "number" }, "name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "InteractionHandovers": { "title": "InteractionHandovers", "type": "object", "properties": { "id": { "type": "number" }, "interactionId": { "type": "number" }, "companyId": { "type": "number", "nullable": true }, "ownerUserId": { "type": "string" }, "assigneeUserId": { "type": "string" }, "returnToOwner": { "type": "number" }, "state": { "type": "string" }, "activeKey": { "type": "number", "nullable": true }, "note": { "type": "string", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "resolvedAt": { "type": "string", "format": "date-time", "nullable": true }, "resolvedByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "interactionId", "ownerUserId", "assigneeUserId", "returnToOwner", "state" ], "additionalProperties": false }, "IndustryGroups": { "title": "IndustryGroups", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewIndustryGroups": { "title": "NewIndustryGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewIndustryGroups', exclude: [ 'id' ] })", "properties": { "name": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "IndustryGroupsWithRelations": { "title": "IndustryGroupsWithRelations", "type": "object", "description": "(tsType: IndustryGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "IndustryGroupsWithRelations" }, "IndustryGroupsPartial": { "title": "IndustryGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "IndustryGroupMembers": { "title": "IndustryGroupMembers", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "industry": { "type": "number", "nullable": true }, "industryGroup": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewIndustryGroupMembers": { "title": "NewIndustryGroupMembers", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewIndustryGroupMembers', exclude: [ 'id' ] })", "properties": { "industry": { "type": "number", "nullable": true }, "industryGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "IndustryGroupMembersWithRelations": { "title": "IndustryGroupMembersWithRelations", "type": "object", "description": "(tsType: IndustryGroupMembersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "industry": { "type": "number", "nullable": true }, "industryGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "IndustryGroupMembersWithRelations" }, "IndustryGroupMembersPartial": { "title": "IndustryGroupMembersPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "industry": { "type": "number", "nullable": true }, "industryGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Industries": { "title": "Industries", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "notes": { "type": "string" } }, "additionalProperties": false }, "NewIndustries": { "title": "NewIndustries", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewIndustries', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "notes": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "IndustriesWithRelations": { "title": "IndustriesWithRelations", "type": "object", "description": "(tsType: IndustriesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "notes": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "IndustriesWithRelations" }, "IndustriesPartial": { "title": "IndustriesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "notes": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Files": { "title": "Files", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "orderid": { "type": "number", "nullable": false }, "tpaInvoice": { "type": "number" }, "externalurl": { "type": "string", "nullable": false }, "internalurl": { "type": "string", "nullable": true }, "createddate": { "type": "string", "format": "date-time", "nullable": true }, "lastupdated": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "id", "orderid", "externalurl" ], "additionalProperties": false }, "NewFiles": { "title": "NewFiles", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewFiles', exclude: [ 'id' ] })", "properties": { "orderid": { "type": "number", "nullable": false }, "tpaInvoice": { "type": "number" }, "externalurl": { "type": "string", "nullable": false }, "internalurl": { "type": "string", "nullable": true }, "createddate": { "type": "string", "format": "date-time", "nullable": true }, "lastupdated": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "orderid", "externalurl" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "FilesWithRelations": { "title": "FilesWithRelations", "type": "object", "description": "(tsType: FilesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "orderid": { "type": "number", "nullable": false }, "tpaInvoice": { "type": "number" }, "externalurl": { "type": "string", "nullable": false }, "internalurl": { "type": "string", "nullable": true }, "createddate": { "type": "string", "format": "date-time", "nullable": true }, "lastupdated": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "id", "orderid", "externalurl" ], "additionalProperties": false, "x-typescript-type": "FilesWithRelations" }, "FilesPartial": { "title": "FilesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "orderid": { "type": "number", "nullable": false }, "tpaInvoice": { "type": "number" }, "externalurl": { "type": "string", "nullable": false }, "internalurl": { "type": "string", "nullable": true }, "createddate": { "type": "string", "format": "date-time", "nullable": true }, "lastupdated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewFileUploads": { "title": "NewFileUploads", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewFileUploads', exclude: [ 'id' ] })", "properties": { "dateUploaded": { "type": "string", "format": "date-time" }, "originalFilename": { "type": "string" }, "filename": { "type": "string" }, "key": { "type": "object" }, "isArchived": { "type": "boolean" }, "encoding": { "type": "string" }, "mimetype": { "type": "string" }, "size": { "type": "number" }, "uploaded_by": { "type": "string" }, "notes": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "tpaInvoice": { "type": "number" }, "documentTypeId": { "type": "number" }, "companyId": { "type": "number" }, "processflowProgressId": { "type": "number" }, "paymentId": { "type": "string" }, "boardTaskId": { "type": "number", "nullable": true }, "boardInline": { "type": "boolean", "nullable": true }, "educationInline": { "type": "boolean", "nullable": true }, "asanaAttachmentGid": { "type": "string", "nullable": true }, "asanaWritebackError": { "type": "string", "nullable": true }, "asanaWritebackErrorAt": { "type": "string", "format": "date-time", "nullable": true }, "asanaWritebackAbandonedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "dateUploaded" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "DocumentType": { "title": "DocumentType", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "docTypeId": { "type": "number" } }, "additionalProperties": false }, "FileUploadsWithRelations": { "title": "FileUploadsWithRelations", "type": "object", "description": "(tsType: FileUploadsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "dateUploaded": { "type": "string", "format": "date-time" }, "originalFilename": { "type": "string" }, "filename": { "type": "string" }, "key": { "type": "object" }, "isArchived": { "type": "boolean" }, "encoding": { "type": "string" }, "mimetype": { "type": "string" }, "size": { "type": "number" }, "uploaded_by": { "type": "string" }, "notes": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "tpaInvoice": { "type": "number" }, "documentTypeId": { "type": "number" }, "companyId": { "type": "number" }, "processflowProgressId": { "type": "number" }, "paymentId": { "type": "string" }, "boardTaskId": { "type": "number", "nullable": true }, "boardInline": { "type": "boolean", "nullable": true }, "educationInline": { "type": "boolean", "nullable": true }, "asanaAttachmentGid": { "type": "string", "nullable": true }, "asanaWritebackError": { "type": "string", "nullable": true }, "asanaWritebackErrorAt": { "type": "string", "format": "date-time", "nullable": true }, "asanaWritebackAbandonedAt": { "type": "string", "format": "date-time", "nullable": true }, "uploadedByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "foreignKey": {}, "documentType": { "$ref": "#/components/schemas/DocumentType" }, "company": { "$ref": "#/components/schemas/Company" }, "processflowProgress": { "$ref": "#/components/schemas/ProcessflowProgress" }, "payment": { "$ref": "#/components/schemas/Payment" } }, "required": [ "dateUploaded" ], "additionalProperties": false, "x-typescript-type": "FileUploadsWithRelations" }, "FileUploadsPartial": { "title": "FileUploadsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "dateUploaded": { "type": "string", "format": "date-time" }, "originalFilename": { "type": "string" }, "filename": { "type": "string" }, "key": { "type": "object" }, "isArchived": { "type": "boolean" }, "encoding": { "type": "string" }, "mimetype": { "type": "string" }, "size": { "type": "number" }, "uploaded_by": { "type": "string" }, "notes": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "tpaInvoice": { "type": "number" }, "documentTypeId": { "type": "number" }, "companyId": { "type": "number" }, "processflowProgressId": { "type": "number" }, "paymentId": { "type": "string" }, "boardTaskId": { "type": "number", "nullable": true }, "boardInline": { "type": "boolean", "nullable": true }, "educationInline": { "type": "boolean", "nullable": true }, "asanaAttachmentGid": { "type": "string", "nullable": true }, "asanaWritebackError": { "type": "string", "nullable": true }, "asanaWritebackErrorAt": { "type": "string", "format": "date-time", "nullable": true }, "asanaWritebackAbandonedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "FieldRuleGroups": { "title": "FieldRuleGroups", "type": "object", "properties": { "businessRuleGroupId": { "type": "number" }, "fieldName": { "type": "string" }, "id": { "type": "number" }, "processFlowGroupId": { "type": "number" } }, "required": [ "id" ], "additionalProperties": false }, "NewFieldRuleGroups": { "title": "NewFieldRuleGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewFieldRuleGroups', exclude: [ 'id' ] })", "properties": { "businessRuleGroupId": { "type": "number" }, "fieldName": { "type": "string" }, "processFlowGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "FieldRuleGroupsWithRelations": { "title": "FieldRuleGroupsWithRelations", "type": "object", "description": "(tsType: FieldRuleGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "businessRuleGroupId": { "type": "number" }, "fieldName": { "type": "string" }, "id": { "type": "number" }, "processFlowGroupId": { "type": "number" } }, "required": [ "id" ], "additionalProperties": false, "x-typescript-type": "FieldRuleGroupsWithRelations" }, "FieldRuleGroupsPartial": { "title": "FieldRuleGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "businessRuleGroupId": { "type": "number" }, "fieldName": { "type": "string" }, "id": { "type": "number" }, "processFlowGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "EmployeeChangeEvent": { "title": "EmployeeChangeEvent", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "eventDate": { "type": "string", "format": "date-time", "nullable": true }, "changedBy": { "type": "string", "nullable": true }, "isChangeOfEnrolled": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": true }, "oldNumber": { "type": "number", "nullable": true }, "newNumber": { "type": "number", "nullable": true } }, "required": [ "isChangeOfEnrolled" ], "additionalProperties": false }, "NewEmployeeChangeEvent": { "title": "NewEmployeeChangeEvent", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewEmployeeChangeEvent', exclude: [ 'id' ] })", "properties": { "eventDate": { "type": "string", "format": "date-time", "nullable": true }, "changedBy": { "type": "string", "nullable": true }, "isChangeOfEnrolled": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": true }, "oldNumber": { "type": "number", "nullable": true }, "newNumber": { "type": "number", "nullable": true } }, "required": [ "isChangeOfEnrolled" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "EmployeeChangeEventWithRelations": { "title": "EmployeeChangeEventWithRelations", "type": "object", "description": "(tsType: EmployeeChangeEventWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "eventDate": { "type": "string", "format": "date-time", "nullable": true }, "changedBy": { "type": "string", "nullable": true }, "isChangeOfEnrolled": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": true }, "oldNumber": { "type": "number", "nullable": true }, "newNumber": { "type": "number", "nullable": true } }, "required": [ "isChangeOfEnrolled" ], "additionalProperties": false, "x-typescript-type": "EmployeeChangeEventWithRelations" }, "EmployeeChangeEventPartial": { "title": "EmployeeChangeEventPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "eventDate": { "type": "string", "format": "date-time", "nullable": true }, "changedBy": { "type": "string", "nullable": true }, "isChangeOfEnrolled": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": true }, "oldNumber": { "type": "number", "nullable": true }, "newNumber": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "EmployeeActivityEvent": { "title": "EmployeeActivityEvent", "type": "object", "properties": { "id": { "type": "string" }, "clearErcUserId": { "type": "string" }, "companyId": { "type": "number" }, "enrollmentSpanId": { "type": "string" }, "eventType": { "type": "string", "enum": [ "login", "invite_accepted", "account_activated", "notification_consent_updated", "hra_completed", "rrg_completed", "video_watched", "education_module_completed", "exercise_logged", "wearable_connected", "activity_synced", "challenge_joined", "challenge_progress", "challenge_completed", "coaching_session_completed", "digest_mailer_engaged", "compliance_message_acknowledged", "healthenews_read", "telemedicine_visit", "prescription_filled", "mental_health_session" ] }, "source": { "type": "string", "enum": [ "in_app", "mobile_app", "wearable_sync", "vendor_report", "staff", "system" ] }, "sourceRef": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" }, "recordedAt": { "type": "string", "format": "date-time" }, "payloadJson": { "type": "object" }, "dedupeKey": { "type": "string" }, "phiTier": { "type": "number" }, "supersedesEventId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "clearErcUserId", "companyId", "eventType", "source", "occurredAt", "recordedAt", "payloadJson", "dedupeKey", "phiTier", "createdAt" ], "additionalProperties": false }, "Email": { "title": "Email", "type": "object", "properties": { "to": { "type": "object" }, "from": { "type": "object" }, "subject": { "type": "string" }, "htmlBody": { "type": "string" }, "templateId": { "type": "string" }, "templateData": { "type": "string" }, "status": { "type": "string" } }, "required": [ "to" ], "additionalProperties": false }, "SendEmail": { "title": "SendEmail", "type": "object", "description": "(tsType: Email, schemaOptions: { title: 'SendEmail' })", "properties": { "to": { "type": "object" }, "from": { "type": "object" }, "subject": { "type": "string" }, "htmlBody": { "type": "string" }, "templateId": { "type": "string" }, "templateData": { "type": "string" }, "status": { "type": "string" } }, "required": [ "to" ], "additionalProperties": false, "x-typescript-type": "Email" }, "EmailTemplate": { "title": "EmailTemplate", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "subject": { "type": "string", "nullable": true }, "bodyHtml": { "type": "string" }, "bodyText": { "type": "string", "nullable": true }, "salesMaterialIdsJson": { "type": "string", "nullable": true }, "calEventTypeKey": { "type": "string", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "audience": { "type": "string", "enum": [ "internal", "employer", "both" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "bodyHtml" ], "additionalProperties": false }, "EducationEngagementEvent": { "title": "EducationEngagementEvent", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "sessionId": { "type": "number", "nullable": true }, "externalId": { "type": "string" }, "personName": { "type": "string", "nullable": true }, "state": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" }, "source": { "type": "string" }, "recordedByUserId": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "companyId", "externalId", "state", "occurredAt", "source" ], "additionalProperties": false }, "Document": { "title": "Document", "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "description": { "type": "string" }, "dateAdded": { "type": "string", "format": "date-time" }, "isArchived": { "type": "boolean" }, "fileUploadId": { "type": "number" }, "thumbnailFileUploadId": { "type": "object", "nullable": true }, "documentCategoryId": { "type": "number" }, "addedByUserId": { "type": "string" } }, "additionalProperties": false }, "DocumentCategory": { "title": "DocumentCategory", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "sortOrder": { "type": "number" } }, "additionalProperties": false }, "DocumentWithRelations": { "title": "DocumentWithRelations", "type": "object", "description": "(tsType: DocumentWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "description": { "type": "string" }, "dateAdded": { "type": "string", "format": "date-time" }, "isArchived": { "type": "boolean" }, "fileUploadId": { "type": "number" }, "thumbnailFileUploadId": { "type": "object", "nullable": true }, "documentCategoryId": { "type": "number" }, "addedByUserId": { "type": "string" }, "fileUpload": { "$ref": "#/components/schemas/FileUploads" }, "foreignKey": {}, "thumbnailFileUpload": { "$ref": "#/components/schemas/FileUploads" }, "documentCategory": { "$ref": "#/components/schemas/DocumentCategory" }, "addedByUser": { "$ref": "#/components/schemas/MarshalledUser" } }, "additionalProperties": false, "x-typescript-type": "DocumentWithRelations" }, "NewDocumentType": { "title": "NewDocumentType", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewDocumentType', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "docTypeId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "DocumentTypeWithRelations": { "title": "DocumentTypeWithRelations", "type": "object", "description": "(tsType: DocumentTypeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "docTypeId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "DocumentTypeWithRelations" }, "DocumentTypePartial": { "title": "DocumentTypePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "docTypeId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CompanyDocumentSyncFolder": { "title": "CompanyDocumentSyncFolder", "type": "object", "properties": { "id": { "type": "number" }, "provider": { "type": "string" }, "folderId": { "type": "string" }, "folderName": { "type": "string" }, "companyId": { "type": "number" }, "status": { "type": "string" }, "lastSyncedAt": { "type": "string", "format": "date-time" }, "lastSyncError": { "type": "string" }, "filesImported": { "type": "number" }, "createdById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "provider", "folderId", "folderName", "companyId", "status", "createdById", "createdAt" ], "additionalProperties": false }, "DocumentSend": { "title": "DocumentSend", "type": "object", "properties": { "id": { "type": "number" }, "documentType": { "type": "string" }, "sentToEmail": { "type": "string" }, "sentAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "receivedAt": { "type": "string", "format": "date-time", "nullable": true }, "receivedByUserId": { "type": "string", "nullable": true }, "viewedAt": { "type": "string", "format": "date-time", "nullable": true }, "signedAt": { "type": "string", "format": "date-time", "nullable": true }, "signedContractId": { "type": "number", "nullable": true }, "ccEmails": { "type": "string", "nullable": true }, "notes": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "deletedById": { "type": "string" }, "companyId": { "type": "number" }, "sentByUserId": { "type": "string" } }, "required": [ "documentType", "status", "companyId" ], "additionalProperties": false }, "DocumentSendWithRelations": { "title": "DocumentSendWithRelations", "type": "object", "description": "(tsType: DocumentSendWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "documentType": { "type": "string" }, "sentToEmail": { "type": "string" }, "sentAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "receivedAt": { "type": "string", "format": "date-time", "nullable": true }, "receivedByUserId": { "type": "string", "nullable": true }, "viewedAt": { "type": "string", "format": "date-time", "nullable": true }, "signedAt": { "type": "string", "format": "date-time", "nullable": true }, "signedContractId": { "type": "number", "nullable": true }, "ccEmails": { "type": "string", "nullable": true }, "notes": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "deletedById": { "type": "string" }, "companyId": { "type": "number" }, "sentByUserId": { "type": "string" }, "company": { "$ref": "#/components/schemas/Company" }, "foreignKey": {}, "sentByUser": { "$ref": "#/components/schemas/MarshalledUser" } }, "required": [ "documentType", "status", "companyId" ], "additionalProperties": false, "x-typescript-type": "DocumentSendWithRelations" }, "NewDocumentCategory": { "title": "NewDocumentCategory", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewDocumentCategory', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "sortOrder": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "DocumentCategoryWithRelations": { "title": "DocumentCategoryWithRelations", "type": "object", "description": "(tsType: DocumentCategoryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "sortOrder": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "DocumentCategoryWithRelations" }, "DocumentCategoryPartial": { "title": "DocumentCategoryPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "sortOrder": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "DefaultUser": { "title": "DefaultUser", "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "processFlowGroup": { "type": "number" }, "roleGroup": { "type": "number" }, "source": { "type": "number" } }, "additionalProperties": false }, "NewDefaultUser": { "title": "NewDefaultUser", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewDefaultUser', exclude: [ 'id' ] })", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "processFlowGroup": { "type": "number" }, "roleGroup": { "type": "number" }, "source": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "DefaultUserWithRelations": { "title": "DefaultUserWithRelations", "type": "object", "description": "(tsType: DefaultUserWithRelations, schemaOptions: { includeRelations: true })", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "processFlowGroup": { "type": "number" }, "roleGroup": { "type": "number" }, "source": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "DefaultUserWithRelations" }, "DefaultUserPartial": { "title": "DefaultUserPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "processFlowGroup": { "type": "number" }, "roleGroup": { "type": "number" }, "source": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "DefaultSources": { "title": "DefaultSources", "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" } }, "additionalProperties": false }, "NewDefaultSources": { "title": "NewDefaultSources", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewDefaultSources', exclude: [ 'id' ] })", "properties": { "description": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "DefaultSourcesWithRelations": { "title": "DefaultSourcesWithRelations", "type": "object", "description": "(tsType: DefaultSourcesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "DefaultSourcesWithRelations" }, "DefaultSourcesPartial": { "title": "DefaultSourcesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Deals": { "title": "Deals", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "companyName": { "type": "string", "nullable": true }, "isAPeo": { "type": "string", "nullable": true }, "dealPayType": { "type": "string", "nullable": true }, "feePercentage": { "type": "string", "nullable": true }, "dealPayStatus": { "type": "string", "nullable": true }, "wasTheDealFinanced": { "type": "string", "nullable": true }, "didTheIrsIssueARefundFullPartialOrNone": { "type": "string", "nullable": true }, "clientRefundAmountBasedOn_941XsBeforeInterest": { "type": "string", "nullable": true }, "clearErcFees": { "type": "string", "nullable": true }, "amountPaid": { "type": "string", "nullable": true }, "amountStillOwed": { "type": "string", "nullable": true }, "q2_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ2_2020": { "type": "string", "nullable": true }, "anyIssuesWithQ2_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ2_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ2_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ2_2020": { "type": "string", "nullable": true }, "q3_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ3_2020": { "type": "string", "nullable": true }, "issuesWithQ3_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ3_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ3_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ3_2020": { "type": "string", "nullable": true }, "q4_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ4_2020": { "type": "string", "nullable": true }, "anyIssuesWithQ4_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ4_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ4_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ4_2020": { "type": "string", "nullable": true }, "taxLiabilityQ2_2020": { "type": "string", "nullable": true }, "taxLiabilityQ4_2021": { "type": "string", "nullable": true }, "taxLiabilityQ3_2020": { "type": "string", "nullable": true }, "taxLiabilityQ4_2020": { "type": "string", "nullable": true }, "taxLiabilityQ2_2021": { "type": "string", "nullable": true }, "taxLiabilityQ1_2021": { "type": "string", "nullable": true }, "taxLiabilityQ3_2021": { "type": "string", "nullable": true }, "q1_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ1_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ1_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ1_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ1_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ1_2021": { "type": "string", "nullable": true }, "q2_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ2_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ2_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ2_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ2_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ2_2021": { "type": "string", "nullable": true }, "didWeFileQ3_941X": { "type": "string", "nullable": true }, "q3_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ3_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ3_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ3_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ3_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ3_2021": { "type": "string", "nullable": true }, "wasThereAQ3Disallowance": { "type": "string", "nullable": true }, "amountStillOwedWithoutQ3": { "type": "string", "nullable": true }, "q3MoneyThatWeMayHaveToRefund": { "type": "string", "nullable": true }, "q4_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ4_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ4_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ4_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ4_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ4_2021": { "type": "string", "nullable": true }, "totalRefundsIssued": { "type": "string", "nullable": true }, "isThereATaxLiability": { "type": "string", "nullable": true }, "howMuchOfErcCreditTransferredDueToTaxLiability": { "type": "string", "nullable": true }, "isThereMonitoring": { "type": "string", "nullable": true }, "whatTypeOfMonitoring": { "type": "string", "nullable": true }, "affliateGroupTeam": { "type": "string", "nullable": true }, "affiliateOnAccount": { "type": "string", "nullable": true }, "mainAffiliateName": { "type": "string", "nullable": true }, "mainAffiliatePercentage": { "type": "string", "nullable": true }, "mainAffiliateCommissionsBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalMainAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidMainAffiliateCommission": { "type": "string", "nullable": true }, "currentStillOwedMainAffiliateCommission": { "type": "string", "nullable": true }, "totalMainAffiliateCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedMainAffiliateCommission": { "type": "string", "nullable": true }, "subAffiliateName": { "type": "string", "nullable": true }, "subAffiliatePercentage": { "type": "string", "nullable": true }, "subAffiliateCommissionBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalSubAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidSubAffiliateCommission": { "type": "string", "nullable": true }, "currentStillOwedSubAffiliateCommission": { "type": "string", "nullable": true }, "totalSubAffiliateCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedSubAffiliateCommission": { "type": "string", "nullable": true }, "mikesRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToMikeBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalMikesCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidMikesCommission": { "type": "string", "nullable": true }, "currentStillOwedMikesCommission": { "type": "string", "nullable": true }, "totalMikesCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedMikesAffiliateCommission": { "type": "string", "nullable": true }, "jacobsRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToJacobBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalJacobsCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidJacobsCommission": { "type": "string", "nullable": true }, "currentStillOwedJacobsCommission": { "type": "string", "nullable": true }, "totalJacobsCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedJacobsAffiliateCommission": { "type": "string", "nullable": true }, "tomsRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToTomBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalTomsCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidTomsCommission": { "type": "string", "nullable": true }, "currentStillOwedTomsCommission": { "type": "string", "nullable": true }, "totalTomsCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedTomsAffiliateCommission": { "type": "string", "nullable": true }, "totalCommissionDue": { "type": "string", "nullable": true }, "totalPaidCommission": { "type": "string", "nullable": true }, "totalCurrentStillOwedCommission": { "type": "string", "nullable": true }, "totalCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "totalPotentialFutureStillOwedAffiliateCommission": { "type": "string", "nullable": true }, "totalCommissionPercentage": { "type": "string", "nullable": true }, "cpaOnFile": { "type": "string", "nullable": true }, "totalCpaCosts": { "type": "string", "nullable": true }, "cpaCostsPaid": { "type": "string", "nullable": true }, "cpaCostsStillOwed": { "type": "string", "nullable": true }, "totalTaxAttorneyCosts": { "type": "string", "nullable": true }, "taxAttorneyCostsPaid": { "type": "string", "nullable": true }, "taxAttorneyCostsOwed": { "type": "string", "nullable": true }, "totalOtherCosts": { "type": "string", "nullable": true }, "otherCostsPaid": { "type": "string", "nullable": true }, "otherCostsStillOwed": { "type": "string", "nullable": true }, "totalCommissionsAndCosts": { "type": "string", "nullable": true }, "netRevenueWithQ3": { "type": "string", "nullable": true }, "netRevenueAsAPercentageOfFeesWithQ3": { "type": "string", "nullable": true }, "netRevenueWithoutQ3": { "type": "string", "nullable": true }, "netRevenueAsAPercentageOfFeesWithoutQ3": { "type": "string", "nullable": true }, "isThereAContract": { "type": "string", "nullable": true }, "isThereAClawbackContract": { "type": "string", "nullable": true }, "wasThereARequestForMoneyBack": { "type": "string", "nullable": true }, "doesTheFileHaveASubstantiationPackage": { "type": "string", "nullable": true }, "estimatedFutureCostToSubstantiateFile": { "type": "string", "nullable": true }, "affiliateRefundLiabilityForAmountAlreadyPaid": { "type": "string", "nullable": true }, "cpaFutureMaintenanceAndAppealCosts": { "type": "string", "nullable": true }, "taxAttorneyProjectedCosts": { "type": "string", "nullable": true }, "estimatedFlatRateToFixAFile": { "type": "string", "nullable": true }, "estimatedPastInHouseCosts": { "type": "string", "nullable": true }, "estimatedFutureInhouseCostsAt_40kPerMonthFor_5yrs": { "type": "string", "nullable": true }, "isBadDeal": { "type": "string", "nullable": true }, "linkToFolder": { "type": "string", "nullable": true }, "folderHref": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewDeals": { "title": "NewDeals", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewDeals', exclude: [ 'id' ] })", "properties": { "companyName": { "type": "string", "nullable": true }, "isAPeo": { "type": "string", "nullable": true }, "dealPayType": { "type": "string", "nullable": true }, "feePercentage": { "type": "string", "nullable": true }, "dealPayStatus": { "type": "string", "nullable": true }, "wasTheDealFinanced": { "type": "string", "nullable": true }, "didTheIrsIssueARefundFullPartialOrNone": { "type": "string", "nullable": true }, "clientRefundAmountBasedOn_941XsBeforeInterest": { "type": "string", "nullable": true }, "clearErcFees": { "type": "string", "nullable": true }, "amountPaid": { "type": "string", "nullable": true }, "amountStillOwed": { "type": "string", "nullable": true }, "q2_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ2_2020": { "type": "string", "nullable": true }, "anyIssuesWithQ2_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ2_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ2_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ2_2020": { "type": "string", "nullable": true }, "q3_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ3_2020": { "type": "string", "nullable": true }, "issuesWithQ3_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ3_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ3_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ3_2020": { "type": "string", "nullable": true }, "q4_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ4_2020": { "type": "string", "nullable": true }, "anyIssuesWithQ4_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ4_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ4_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ4_2020": { "type": "string", "nullable": true }, "taxLiabilityQ2_2020": { "type": "string", "nullable": true }, "taxLiabilityQ4_2021": { "type": "string", "nullable": true }, "taxLiabilityQ3_2020": { "type": "string", "nullable": true }, "taxLiabilityQ4_2020": { "type": "string", "nullable": true }, "taxLiabilityQ2_2021": { "type": "string", "nullable": true }, "taxLiabilityQ1_2021": { "type": "string", "nullable": true }, "taxLiabilityQ3_2021": { "type": "string", "nullable": true }, "q1_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ1_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ1_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ1_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ1_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ1_2021": { "type": "string", "nullable": true }, "q2_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ2_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ2_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ2_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ2_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ2_2021": { "type": "string", "nullable": true }, "didWeFileQ3_941X": { "type": "string", "nullable": true }, "q3_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ3_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ3_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ3_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ3_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ3_2021": { "type": "string", "nullable": true }, "wasThereAQ3Disallowance": { "type": "string", "nullable": true }, "amountStillOwedWithoutQ3": { "type": "string", "nullable": true }, "q3MoneyThatWeMayHaveToRefund": { "type": "string", "nullable": true }, "q4_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ4_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ4_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ4_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ4_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ4_2021": { "type": "string", "nullable": true }, "totalRefundsIssued": { "type": "string", "nullable": true }, "isThereATaxLiability": { "type": "string", "nullable": true }, "howMuchOfErcCreditTransferredDueToTaxLiability": { "type": "string", "nullable": true }, "isThereMonitoring": { "type": "string", "nullable": true }, "whatTypeOfMonitoring": { "type": "string", "nullable": true }, "affliateGroupTeam": { "type": "string", "nullable": true }, "affiliateOnAccount": { "type": "string", "nullable": true }, "mainAffiliateName": { "type": "string", "nullable": true }, "mainAffiliatePercentage": { "type": "string", "nullable": true }, "mainAffiliateCommissionsBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalMainAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidMainAffiliateCommission": { "type": "string", "nullable": true }, "currentStillOwedMainAffiliateCommission": { "type": "string", "nullable": true }, "totalMainAffiliateCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedMainAffiliateCommission": { "type": "string", "nullable": true }, "subAffiliateName": { "type": "string", "nullable": true }, "subAffiliatePercentage": { "type": "string", "nullable": true }, "subAffiliateCommissionBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalSubAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidSubAffiliateCommission": { "type": "string", "nullable": true }, "currentStillOwedSubAffiliateCommission": { "type": "string", "nullable": true }, "totalSubAffiliateCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedSubAffiliateCommission": { "type": "string", "nullable": true }, "mikesRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToMikeBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalMikesCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidMikesCommission": { "type": "string", "nullable": true }, "currentStillOwedMikesCommission": { "type": "string", "nullable": true }, "totalMikesCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedMikesAffiliateCommission": { "type": "string", "nullable": true }, "jacobsRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToJacobBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalJacobsCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidJacobsCommission": { "type": "string", "nullable": true }, "currentStillOwedJacobsCommission": { "type": "string", "nullable": true }, "totalJacobsCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedJacobsAffiliateCommission": { "type": "string", "nullable": true }, "tomsRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToTomBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalTomsCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidTomsCommission": { "type": "string", "nullable": true }, "currentStillOwedTomsCommission": { "type": "string", "nullable": true }, "totalTomsCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedTomsAffiliateCommission": { "type": "string", "nullable": true }, "totalCommissionDue": { "type": "string", "nullable": true }, "totalPaidCommission": { "type": "string", "nullable": true }, "totalCurrentStillOwedCommission": { "type": "string", "nullable": true }, "totalCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "totalPotentialFutureStillOwedAffiliateCommission": { "type": "string", "nullable": true }, "totalCommissionPercentage": { "type": "string", "nullable": true }, "cpaOnFile": { "type": "string", "nullable": true }, "totalCpaCosts": { "type": "string", "nullable": true }, "cpaCostsPaid": { "type": "string", "nullable": true }, "cpaCostsStillOwed": { "type": "string", "nullable": true }, "totalTaxAttorneyCosts": { "type": "string", "nullable": true }, "taxAttorneyCostsPaid": { "type": "string", "nullable": true }, "taxAttorneyCostsOwed": { "type": "string", "nullable": true }, "totalOtherCosts": { "type": "string", "nullable": true }, "otherCostsPaid": { "type": "string", "nullable": true }, "otherCostsStillOwed": { "type": "string", "nullable": true }, "totalCommissionsAndCosts": { "type": "string", "nullable": true }, "netRevenueWithQ3": { "type": "string", "nullable": true }, "netRevenueAsAPercentageOfFeesWithQ3": { "type": "string", "nullable": true }, "netRevenueWithoutQ3": { "type": "string", "nullable": true }, "netRevenueAsAPercentageOfFeesWithoutQ3": { "type": "string", "nullable": true }, "isThereAContract": { "type": "string", "nullable": true }, "isThereAClawbackContract": { "type": "string", "nullable": true }, "wasThereARequestForMoneyBack": { "type": "string", "nullable": true }, "doesTheFileHaveASubstantiationPackage": { "type": "string", "nullable": true }, "estimatedFutureCostToSubstantiateFile": { "type": "string", "nullable": true }, "affiliateRefundLiabilityForAmountAlreadyPaid": { "type": "string", "nullable": true }, "cpaFutureMaintenanceAndAppealCosts": { "type": "string", "nullable": true }, "taxAttorneyProjectedCosts": { "type": "string", "nullable": true }, "estimatedFlatRateToFixAFile": { "type": "string", "nullable": true }, "estimatedPastInHouseCosts": { "type": "string", "nullable": true }, "estimatedFutureInhouseCostsAt_40kPerMonthFor_5yrs": { "type": "string", "nullable": true }, "isBadDeal": { "type": "string", "nullable": true }, "linkToFolder": { "type": "string", "nullable": true }, "folderHref": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "DealsWithRelations": { "title": "DealsWithRelations", "type": "object", "description": "(tsType: DealsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "companyName": { "type": "string", "nullable": true }, "isAPeo": { "type": "string", "nullable": true }, "dealPayType": { "type": "string", "nullable": true }, "feePercentage": { "type": "string", "nullable": true }, "dealPayStatus": { "type": "string", "nullable": true }, "wasTheDealFinanced": { "type": "string", "nullable": true }, "didTheIrsIssueARefundFullPartialOrNone": { "type": "string", "nullable": true }, "clientRefundAmountBasedOn_941XsBeforeInterest": { "type": "string", "nullable": true }, "clearErcFees": { "type": "string", "nullable": true }, "amountPaid": { "type": "string", "nullable": true }, "amountStillOwed": { "type": "string", "nullable": true }, "q2_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ2_2020": { "type": "string", "nullable": true }, "anyIssuesWithQ2_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ2_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ2_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ2_2020": { "type": "string", "nullable": true }, "q3_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ3_2020": { "type": "string", "nullable": true }, "issuesWithQ3_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ3_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ3_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ3_2020": { "type": "string", "nullable": true }, "q4_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ4_2020": { "type": "string", "nullable": true }, "anyIssuesWithQ4_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ4_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ4_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ4_2020": { "type": "string", "nullable": true }, "taxLiabilityQ2_2020": { "type": "string", "nullable": true }, "taxLiabilityQ4_2021": { "type": "string", "nullable": true }, "taxLiabilityQ3_2020": { "type": "string", "nullable": true }, "taxLiabilityQ4_2020": { "type": "string", "nullable": true }, "taxLiabilityQ2_2021": { "type": "string", "nullable": true }, "taxLiabilityQ1_2021": { "type": "string", "nullable": true }, "taxLiabilityQ3_2021": { "type": "string", "nullable": true }, "q1_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ1_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ1_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ1_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ1_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ1_2021": { "type": "string", "nullable": true }, "q2_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ2_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ2_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ2_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ2_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ2_2021": { "type": "string", "nullable": true }, "didWeFileQ3_941X": { "type": "string", "nullable": true }, "q3_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ3_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ3_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ3_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ3_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ3_2021": { "type": "string", "nullable": true }, "wasThereAQ3Disallowance": { "type": "string", "nullable": true }, "amountStillOwedWithoutQ3": { "type": "string", "nullable": true }, "q3MoneyThatWeMayHaveToRefund": { "type": "string", "nullable": true }, "q4_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ4_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ4_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ4_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ4_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ4_2021": { "type": "string", "nullable": true }, "totalRefundsIssued": { "type": "string", "nullable": true }, "isThereATaxLiability": { "type": "string", "nullable": true }, "howMuchOfErcCreditTransferredDueToTaxLiability": { "type": "string", "nullable": true }, "isThereMonitoring": { "type": "string", "nullable": true }, "whatTypeOfMonitoring": { "type": "string", "nullable": true }, "affliateGroupTeam": { "type": "string", "nullable": true }, "affiliateOnAccount": { "type": "string", "nullable": true }, "mainAffiliateName": { "type": "string", "nullable": true }, "mainAffiliatePercentage": { "type": "string", "nullable": true }, "mainAffiliateCommissionsBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalMainAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidMainAffiliateCommission": { "type": "string", "nullable": true }, "currentStillOwedMainAffiliateCommission": { "type": "string", "nullable": true }, "totalMainAffiliateCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedMainAffiliateCommission": { "type": "string", "nullable": true }, "subAffiliateName": { "type": "string", "nullable": true }, "subAffiliatePercentage": { "type": "string", "nullable": true }, "subAffiliateCommissionBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalSubAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidSubAffiliateCommission": { "type": "string", "nullable": true }, "currentStillOwedSubAffiliateCommission": { "type": "string", "nullable": true }, "totalSubAffiliateCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedSubAffiliateCommission": { "type": "string", "nullable": true }, "mikesRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToMikeBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalMikesCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidMikesCommission": { "type": "string", "nullable": true }, "currentStillOwedMikesCommission": { "type": "string", "nullable": true }, "totalMikesCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedMikesAffiliateCommission": { "type": "string", "nullable": true }, "jacobsRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToJacobBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalJacobsCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidJacobsCommission": { "type": "string", "nullable": true }, "currentStillOwedJacobsCommission": { "type": "string", "nullable": true }, "totalJacobsCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedJacobsAffiliateCommission": { "type": "string", "nullable": true }, "tomsRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToTomBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalTomsCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidTomsCommission": { "type": "string", "nullable": true }, "currentStillOwedTomsCommission": { "type": "string", "nullable": true }, "totalTomsCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedTomsAffiliateCommission": { "type": "string", "nullable": true }, "totalCommissionDue": { "type": "string", "nullable": true }, "totalPaidCommission": { "type": "string", "nullable": true }, "totalCurrentStillOwedCommission": { "type": "string", "nullable": true }, "totalCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "totalPotentialFutureStillOwedAffiliateCommission": { "type": "string", "nullable": true }, "totalCommissionPercentage": { "type": "string", "nullable": true }, "cpaOnFile": { "type": "string", "nullable": true }, "totalCpaCosts": { "type": "string", "nullable": true }, "cpaCostsPaid": { "type": "string", "nullable": true }, "cpaCostsStillOwed": { "type": "string", "nullable": true }, "totalTaxAttorneyCosts": { "type": "string", "nullable": true }, "taxAttorneyCostsPaid": { "type": "string", "nullable": true }, "taxAttorneyCostsOwed": { "type": "string", "nullable": true }, "totalOtherCosts": { "type": "string", "nullable": true }, "otherCostsPaid": { "type": "string", "nullable": true }, "otherCostsStillOwed": { "type": "string", "nullable": true }, "totalCommissionsAndCosts": { "type": "string", "nullable": true }, "netRevenueWithQ3": { "type": "string", "nullable": true }, "netRevenueAsAPercentageOfFeesWithQ3": { "type": "string", "nullable": true }, "netRevenueWithoutQ3": { "type": "string", "nullable": true }, "netRevenueAsAPercentageOfFeesWithoutQ3": { "type": "string", "nullable": true }, "isThereAContract": { "type": "string", "nullable": true }, "isThereAClawbackContract": { "type": "string", "nullable": true }, "wasThereARequestForMoneyBack": { "type": "string", "nullable": true }, "doesTheFileHaveASubstantiationPackage": { "type": "string", "nullable": true }, "estimatedFutureCostToSubstantiateFile": { "type": "string", "nullable": true }, "affiliateRefundLiabilityForAmountAlreadyPaid": { "type": "string", "nullable": true }, "cpaFutureMaintenanceAndAppealCosts": { "type": "string", "nullable": true }, "taxAttorneyProjectedCosts": { "type": "string", "nullable": true }, "estimatedFlatRateToFixAFile": { "type": "string", "nullable": true }, "estimatedPastInHouseCosts": { "type": "string", "nullable": true }, "estimatedFutureInhouseCostsAt_40kPerMonthFor_5yrs": { "type": "string", "nullable": true }, "isBadDeal": { "type": "string", "nullable": true }, "linkToFolder": { "type": "string", "nullable": true }, "folderHref": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "DealsWithRelations" }, "DealsPartial": { "title": "DealsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "companyName": { "type": "string", "nullable": true }, "isAPeo": { "type": "string", "nullable": true }, "dealPayType": { "type": "string", "nullable": true }, "feePercentage": { "type": "string", "nullable": true }, "dealPayStatus": { "type": "string", "nullable": true }, "wasTheDealFinanced": { "type": "string", "nullable": true }, "didTheIrsIssueARefundFullPartialOrNone": { "type": "string", "nullable": true }, "clientRefundAmountBasedOn_941XsBeforeInterest": { "type": "string", "nullable": true }, "clearErcFees": { "type": "string", "nullable": true }, "amountPaid": { "type": "string", "nullable": true }, "amountStillOwed": { "type": "string", "nullable": true }, "q2_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ2_2020": { "type": "string", "nullable": true }, "anyIssuesWithQ2_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ2_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ2_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ2_2020": { "type": "string", "nullable": true }, "q3_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ3_2020": { "type": "string", "nullable": true }, "issuesWithQ3_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ3_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ3_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ3_2020": { "type": "string", "nullable": true }, "q4_2020_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ4_2020": { "type": "string", "nullable": true }, "anyIssuesWithQ4_2020IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ4_2020": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ4_2020": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ4_2020": { "type": "string", "nullable": true }, "taxLiabilityQ2_2020": { "type": "string", "nullable": true }, "taxLiabilityQ4_2021": { "type": "string", "nullable": true }, "taxLiabilityQ3_2020": { "type": "string", "nullable": true }, "taxLiabilityQ4_2020": { "type": "string", "nullable": true }, "taxLiabilityQ2_2021": { "type": "string", "nullable": true }, "taxLiabilityQ1_2021": { "type": "string", "nullable": true }, "taxLiabilityQ3_2021": { "type": "string", "nullable": true }, "q1_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ1_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ1_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ1_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ1_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ1_2021": { "type": "string", "nullable": true }, "q2_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ2_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ2_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ2_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ2_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ2_2021": { "type": "string", "nullable": true }, "didWeFileQ3_941X": { "type": "string", "nullable": true }, "q3_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ3_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ3_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ3_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ3_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ3_2021": { "type": "string", "nullable": true }, "wasThereAQ3Disallowance": { "type": "string", "nullable": true }, "amountStillOwedWithoutQ3": { "type": "string", "nullable": true }, "q3MoneyThatWeMayHaveToRefund": { "type": "string", "nullable": true }, "q4_2021_941XAmountFiled": { "type": "string", "nullable": true }, "didIrsRecieveQ4_2021": { "type": "string", "nullable": true }, "anyIssuesWithQ4_2021IrsTranscripts": { "type": "string", "nullable": true }, "amountOnFileWithTheIrsForQ4_2021": { "type": "string", "nullable": true }, "didTheIrsIssueARefundForQ4_2021": { "type": "string", "nullable": true }, "amountOfRefundIssuedForQ4_2021": { "type": "string", "nullable": true }, "totalRefundsIssued": { "type": "string", "nullable": true }, "isThereATaxLiability": { "type": "string", "nullable": true }, "howMuchOfErcCreditTransferredDueToTaxLiability": { "type": "string", "nullable": true }, "isThereMonitoring": { "type": "string", "nullable": true }, "whatTypeOfMonitoring": { "type": "string", "nullable": true }, "affliateGroupTeam": { "type": "string", "nullable": true }, "affiliateOnAccount": { "type": "string", "nullable": true }, "mainAffiliateName": { "type": "string", "nullable": true }, "mainAffiliatePercentage": { "type": "string", "nullable": true }, "mainAffiliateCommissionsBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalMainAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidMainAffiliateCommission": { "type": "string", "nullable": true }, "currentStillOwedMainAffiliateCommission": { "type": "string", "nullable": true }, "totalMainAffiliateCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedMainAffiliateCommission": { "type": "string", "nullable": true }, "subAffiliateName": { "type": "string", "nullable": true }, "subAffiliatePercentage": { "type": "string", "nullable": true }, "subAffiliateCommissionBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalSubAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidSubAffiliateCommission": { "type": "string", "nullable": true }, "currentStillOwedSubAffiliateCommission": { "type": "string", "nullable": true }, "totalSubAffiliateCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedSubAffiliateCommission": { "type": "string", "nullable": true }, "mikesRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToMikeBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalMikesCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidMikesCommission": { "type": "string", "nullable": true }, "currentStillOwedMikesCommission": { "type": "string", "nullable": true }, "totalMikesCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedMikesAffiliateCommission": { "type": "string", "nullable": true }, "jacobsRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToJacobBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalJacobsCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidJacobsCommission": { "type": "string", "nullable": true }, "currentStillOwedJacobsCommission": { "type": "string", "nullable": true }, "totalJacobsCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedJacobsAffiliateCommission": { "type": "string", "nullable": true }, "tomsRelatedCommissionPercentage": { "type": "string", "nullable": true }, "amountDueToTomBasedOnAmountRefunded": { "type": "string", "nullable": true }, "totalTomsCommissionDueBasedOnFeesAlreadyPaid": { "type": "string", "nullable": true }, "currentPaidTomsCommission": { "type": "string", "nullable": true }, "currentStillOwedTomsCommission": { "type": "string", "nullable": true }, "totalTomsCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "potentialFutureStillOwedTomsAffiliateCommission": { "type": "string", "nullable": true }, "totalCommissionDue": { "type": "string", "nullable": true }, "totalPaidCommission": { "type": "string", "nullable": true }, "totalCurrentStillOwedCommission": { "type": "string", "nullable": true }, "totalCommissionBasedOnOverallClearErcFees": { "type": "string", "nullable": true }, "totalPotentialFutureStillOwedAffiliateCommission": { "type": "string", "nullable": true }, "totalCommissionPercentage": { "type": "string", "nullable": true }, "cpaOnFile": { "type": "string", "nullable": true }, "totalCpaCosts": { "type": "string", "nullable": true }, "cpaCostsPaid": { "type": "string", "nullable": true }, "cpaCostsStillOwed": { "type": "string", "nullable": true }, "totalTaxAttorneyCosts": { "type": "string", "nullable": true }, "taxAttorneyCostsPaid": { "type": "string", "nullable": true }, "taxAttorneyCostsOwed": { "type": "string", "nullable": true }, "totalOtherCosts": { "type": "string", "nullable": true }, "otherCostsPaid": { "type": "string", "nullable": true }, "otherCostsStillOwed": { "type": "string", "nullable": true }, "totalCommissionsAndCosts": { "type": "string", "nullable": true }, "netRevenueWithQ3": { "type": "string", "nullable": true }, "netRevenueAsAPercentageOfFeesWithQ3": { "type": "string", "nullable": true }, "netRevenueWithoutQ3": { "type": "string", "nullable": true }, "netRevenueAsAPercentageOfFeesWithoutQ3": { "type": "string", "nullable": true }, "isThereAContract": { "type": "string", "nullable": true }, "isThereAClawbackContract": { "type": "string", "nullable": true }, "wasThereARequestForMoneyBack": { "type": "string", "nullable": true }, "doesTheFileHaveASubstantiationPackage": { "type": "string", "nullable": true }, "estimatedFutureCostToSubstantiateFile": { "type": "string", "nullable": true }, "affiliateRefundLiabilityForAmountAlreadyPaid": { "type": "string", "nullable": true }, "cpaFutureMaintenanceAndAppealCosts": { "type": "string", "nullable": true }, "taxAttorneyProjectedCosts": { "type": "string", "nullable": true }, "estimatedFlatRateToFixAFile": { "type": "string", "nullable": true }, "estimatedPastInHouseCosts": { "type": "string", "nullable": true }, "estimatedFutureInhouseCostsAt_40kPerMonthFor_5yrs": { "type": "string", "nullable": true }, "isBadDeal": { "type": "string", "nullable": true }, "linkToFolder": { "type": "string", "nullable": true }, "folderHref": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "DealTags": { "title": "DealTags", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "dealId": { "type": "number", "nullable": true }, "tagId": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewDealTags": { "title": "NewDealTags", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewDealTags', exclude: [ 'id' ] })", "properties": { "dealId": { "type": "number", "nullable": true }, "tagId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "DealTagsWithRelations": { "title": "DealTagsWithRelations", "type": "object", "description": "(tsType: DealTagsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "dealId": { "type": "number", "nullable": true }, "tagId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "DealTagsWithRelations" }, "DealTagsPartial": { "title": "DealTagsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "dealId": { "type": "number", "nullable": true }, "tagId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "DealTagOptions": { "title": "DealTagOptions", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "fieldName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewDealTagOptions": { "title": "NewDealTagOptions", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewDealTagOptions', exclude: [ 'id' ] })", "properties": { "name": { "type": "string", "nullable": true }, "fieldName": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "DealTagOptionsWithRelations": { "title": "DealTagOptionsWithRelations", "type": "object", "description": "(tsType: DealTagOptionsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "fieldName": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "DealTagOptionsWithRelations" }, "DealTagOptionsPartial": { "title": "DealTagOptionsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "fieldName": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ComparrisonTypes": { "title": "ComparrisonTypes", "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "usesField_2": { "type": "number" } }, "required": [ "id", "usesField_2" ], "additionalProperties": false }, "NewComparrisonTypes": { "title": "NewComparrisonTypes", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewComparrisonTypes', exclude: [ 'id' ] })", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "usesField_2": { "type": "number" } }, "required": [ "usesField_2" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ComparrisonTypesWithRelations": { "title": "ComparrisonTypesWithRelations", "type": "object", "description": "(tsType: ComparrisonTypesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "usesField_2": { "type": "number" } }, "required": [ "id", "usesField_2" ], "additionalProperties": false, "x-typescript-type": "ComparrisonTypesWithRelations" }, "ComparrisonTypesPartial": { "title": "ComparrisonTypesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "usesField_2": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CompanyWatchers": { "title": "CompanyWatchers", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "userId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "companyId", "userId" ], "additionalProperties": false }, "CompanyWatchersWithRelations": { "title": "CompanyWatchersWithRelations", "type": "object", "description": "(tsType: CompanyWatchersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "userId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "companyId", "userId" ], "additionalProperties": false, "x-typescript-type": "CompanyWatchersWithRelations" }, "CompanyReviewUsers": { "title": "CompanyReviewUsers", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "string" }, "isNextReviewer": { "type": "boolean" } }, "additionalProperties": false }, "CompanyReviewUsersWithRelations": { "title": "CompanyReviewUsersWithRelations", "type": "object", "description": "(tsType: CompanyReviewUsersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "string" }, "isNextReviewer": { "type": "boolean" } }, "additionalProperties": false, "x-typescript-type": "CompanyReviewUsersWithRelations" }, "CompanyRepairStages": { "title": "CompanyRepairStages", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "stage": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewCompanyRepairStages": { "title": "NewCompanyRepairStages", "type": "object", "description": "(tsType: CompanyRepairStages, schemaOptions: { title: 'NewCompanyRepairStages' })", "properties": { "id": { "type": "number", "nullable": false }, "stage": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "CompanyRepairStages" }, "CompanyRepairStagesWithRelations": { "title": "CompanyRepairStagesWithRelations", "type": "object", "description": "(tsType: CompanyRepairStagesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "stage": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "CompanyRepairStagesWithRelations" }, "CompanyRepairStagesPartial": { "title": "CompanyRepairStagesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "stage": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CompanyProductStage": { "title": "CompanyProductStage", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": true }, "stageId": { "type": "number", "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": false }, "updatedByUser": { "type": "string", "nullable": true } }, "required": [ "lastUpdated" ], "additionalProperties": false }, "NewCompanyProductStage": { "title": "NewCompanyProductStage", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCompanyProductStage', exclude: [ 'id' ] })", "properties": { "companyId": { "type": "number", "nullable": true }, "stageId": { "type": "number", "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": false }, "updatedByUser": { "type": "string", "nullable": true } }, "required": [ "lastUpdated" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CompanyProductStageWithRelations": { "title": "CompanyProductStageWithRelations", "type": "object", "description": "(tsType: CompanyProductStageWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": true }, "stageId": { "type": "number", "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": false }, "updatedByUser": { "type": "string", "nullable": true } }, "required": [ "lastUpdated" ], "additionalProperties": false, "x-typescript-type": "CompanyProductStageWithRelations" }, "CompanyProductStagePartial": { "title": "CompanyProductStagePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "companyId": { "type": "number", "nullable": true }, "stageId": { "type": "number", "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": false }, "updatedByUser": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CompanyModuleEntitlement": { "title": "CompanyModuleEntitlement", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "moduleKey": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string", "nullable": true } }, "required": [ "companyId", "moduleKey" ], "additionalProperties": false }, "CompanyMandateAssignment": { "title": "CompanyMandateAssignment", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "number" }, "mandateId": { "type": "number" }, "mandateEffectId": { "type": "number" }, "industryGroupId": { "type": "number" }, "suggestedByAi": { "type": "boolean" }, "status": { "type": "string" }, "impact": { "type": "string", "nullable": true }, "rejectionReason": { "type": "string", "nullable": true } }, "required": [ "companyId", "mandateId", "mandateEffectId" ], "additionalProperties": false }, "NewCompanyMandateAssignment": { "title": "NewCompanyMandateAssignment", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCompanyMandateAssignment', exclude: [ 'id' ] })", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "number" }, "mandateId": { "type": "number" }, "mandateEffectId": { "type": "number" }, "industryGroupId": { "type": "number" }, "suggestedByAi": { "type": "boolean" }, "status": { "type": "string" }, "impact": { "type": "string", "nullable": true }, "rejectionReason": { "type": "string", "nullable": true } }, "required": [ "companyId", "mandateId", "mandateEffectId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CompanyMandateAssignmentWithRelations": { "title": "CompanyMandateAssignmentWithRelations", "type": "object", "description": "(tsType: CompanyMandateAssignmentWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "number" }, "mandateId": { "type": "number" }, "mandateEffectId": { "type": "number" }, "industryGroupId": { "type": "number" }, "suggestedByAi": { "type": "boolean" }, "status": { "type": "string" }, "impact": { "type": "string", "nullable": true }, "rejectionReason": { "type": "string", "nullable": true } }, "required": [ "companyId", "mandateId", "mandateEffectId" ], "additionalProperties": false, "x-typescript-type": "CompanyMandateAssignmentWithRelations" }, "CompanyMandateAssignmentPartial": { "title": "CompanyMandateAssignmentPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "number" }, "mandateId": { "type": "number" }, "mandateEffectId": { "type": "number" }, "industryGroupId": { "type": "number" }, "suggestedByAi": { "type": "boolean" }, "status": { "type": "string" }, "impact": { "type": "string", "nullable": true }, "rejectionReason": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CompanyLocations": { "title": "CompanyLocations", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "percentOfBusiness": { "type": "number", "nullable": true } }, "required": [ "companyId", "state" ], "additionalProperties": false }, "NewCompanyLocations": { "title": "NewCompanyLocations", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCompanyLocations', exclude: [ 'id' ] })", "properties": { "companyId": { "type": "number" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "percentOfBusiness": { "type": "number", "nullable": true } }, "required": [ "companyId", "state" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CompanyLocationsWithRelations": { "title": "CompanyLocationsWithRelations", "type": "object", "description": "(tsType: CompanyLocationsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "percentOfBusiness": { "type": "number", "nullable": true } }, "required": [ "companyId", "state" ], "additionalProperties": false, "x-typescript-type": "CompanyLocationsWithRelations" }, "CompanyLocationsPartial": { "title": "CompanyLocationsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "percentOfBusiness": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CompanyGroup": { "title": "CompanyGroup", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "masterCompany": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewCompanyGroup": { "title": "NewCompanyGroup", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCompanyGroup', exclude: [ 'id' ] })", "properties": { "masterCompany": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "CompanyGroupWithRelations": { "title": "CompanyGroupWithRelations", "type": "object", "description": "(tsType: CompanyGroupWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "masterCompany": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "CompanyGroupWithRelations" }, "CompanyGroupPartial": { "title": "CompanyGroupPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "masterCompany": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CompanyEmail": { "title": "CompanyEmail", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "email": { "type": "string" }, "label": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time" }, "deletedById": { "type": "string" } }, "required": [ "companyId", "email", "createdAt" ], "additionalProperties": false }, "CompanyDocument": { "title": "CompanyDocument", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "s3Key": { "type": "string" }, "label": { "type": "string" }, "originalFilename": { "type": "string" }, "mimetype": { "type": "string" }, "size": { "type": "number" }, "notes": { "type": "string" }, "uploadedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "deletedById": { "type": "string" }, "documentType": { "type": "string" }, "visibleToEmployer": { "type": "boolean" }, "sourceProvider": { "type": "string" }, "sourceFileId": { "type": "string" }, "sourceFolderId": { "type": "string" }, "contentHash": { "type": "string" }, "ownerUserId": { "type": "string" }, "analysisRunId": { "type": "string" }, "censusEmployeeId": { "type": "number" }, "censusEmployeePersonId": { "type": "number" } }, "required": [ "companyId", "s3Key", "label", "originalFilename", "uploadedById", "createdAt" ], "additionalProperties": false }, "Date": {}, "NewClearErcUserInCompany": { "title": "NewClearErcUserInCompany", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewClearErcUserInCompany', exclude: [ 'id' ] }), , , {\"indexInfo\":{\"email\":{\"unique\":false},\"username\":{\"username\":{\"unique\":true}},\"userKind\":{\"userKind\":{\"unique\":false}}}}", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "invitedAt": { "type": "string", "format": "date-time" }, "accountSetupAt": { "type": "string", "format": "date-time" }, "inviteSentAt": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string" }, "company": { "type": "number" }, "defaultProcessflowId": { "type": "number" }, "closerId": { "type": "string" }, "cpaUserId": { "type": "string" }, "accountManagerUserId": { "type": "string" }, "affiliateUserId": { "type": "string" }, "docCollectorId": { "type": "string" }, "affiliateDetails": { "type": "string" }, "taxAttorneyUserId": { "type": "string" }, "lastLoggedIn": { "type": "string", "format": "date-time" }, "isTempPassword": { "type": "boolean" }, "userStatus": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "utm": { "type": "string" }, "emailVerified": { "type": "boolean" }, "realm": { "type": "string" }, "stPass": { "type": "string" }, "stCompany": { "type": "number" }, "lastLoginHost": { "type": "string" }, "stUrl": { "type": "string" }, "verificationToken": { "type": "string" }, "passwordResetExpiresAt": { "type": "string", "format": "date-time" }, "pf7percentage": { "type": "number" }, "clientStatus": { "type": "number" }, "notificationConsentAt": { "type": "string", "format": "date-time" }, "termsVersionAccepted": { "type": "string" }, "notificationCategoryConsent": { "type": "string" }, "pushEnabled": { "type": "boolean" }, "notificationConsentIp": { "type": "string" }, "notificationConsentName": { "type": "string" }, "registrationIp": { "type": "string" }, "registrationLocation": { "type": "string" }, "smsOptedOut": { "type": "boolean" }, "smsOptedOutAt": { "type": "string", "format": "date-time" }, "smsSendTimezone": { "type": "string" }, "smsLastDigestAt": { "type": "string", "format": "date-time" }, "notificationDigestFrequency": { "type": "string", "enum": [ "daily", "weekly" ] }, "emailLastDigestAt": { "type": "string", "format": "date-time" }, "image": { "type": "string", "nullable": true }, "userKind": { "type": "string" } }, "required": [ "email", "username" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ClearErcUserPartial": { "title": "ClearErcUserPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true }), , , {\"indexInfo\":{\"email\":{\"unique\":false},\"username\":{\"username\":{\"unique\":true}},\"userKind\":{\"userKind\":{\"unique\":false}}}}", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "invitedAt": { "type": "string", "format": "date-time" }, "accountSetupAt": { "type": "string", "format": "date-time" }, "inviteSentAt": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string" }, "company": { "type": "number" }, "defaultProcessflowId": { "type": "number" }, "closerId": { "type": "string" }, "cpaUserId": { "type": "string" }, "accountManagerUserId": { "type": "string" }, "affiliateUserId": { "type": "string" }, "docCollectorId": { "type": "string" }, "affiliateDetails": { "type": "string" }, "taxAttorneyUserId": { "type": "string" }, "lastLoggedIn": { "type": "string", "format": "date-time" }, "isTempPassword": { "type": "boolean" }, "userStatus": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "utm": { "type": "string" }, "emailVerified": { "type": "boolean" }, "realm": { "type": "string" }, "stPass": { "type": "string" }, "stCompany": { "type": "number" }, "lastLoginHost": { "type": "string" }, "stUrl": { "type": "string" }, "verificationToken": { "type": "string" }, "passwordResetExpiresAt": { "type": "string", "format": "date-time" }, "pf7percentage": { "type": "number" }, "clientStatus": { "type": "number" }, "notificationConsentAt": { "type": "string", "format": "date-time" }, "termsVersionAccepted": { "type": "string" }, "notificationCategoryConsent": { "type": "string" }, "pushEnabled": { "type": "boolean" }, "notificationConsentIp": { "type": "string" }, "notificationConsentName": { "type": "string" }, "registrationIp": { "type": "string" }, "registrationLocation": { "type": "string" }, "smsOptedOut": { "type": "boolean" }, "smsOptedOutAt": { "type": "string", "format": "date-time" }, "smsSendTimezone": { "type": "string" }, "smsLastDigestAt": { "type": "string", "format": "date-time" }, "notificationDigestFrequency": { "type": "string", "enum": [ "daily", "weekly" ] }, "emailLastDigestAt": { "type": "string", "format": "date-time" }, "image": { "type": "string", "nullable": true }, "userKind": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CompanyChecklistItem": { "title": "CompanyChecklistItem", "type": "object", "properties": { "id": { "type": "number" }, "itemKey": { "type": "string" }, "checkedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "number" }, "checkedByUserId": { "type": "object", "nullable": true }, "assignedUserId": { "type": "object", "nullable": true } }, "required": [ "itemKey", "companyId" ], "additionalProperties": false }, "CompanyWithRelations": { "title": "CompanyWithRelations", "type": "object", "description": "(tsType: CompanyWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "expectedLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "goLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "address": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "bankAddress": { "type": "string" }, "bankCity": { "type": "string" }, "bankState": { "type": "string" }, "bankZipCode": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "createdByUserId": { "type": "string" }, "ownedById": { "type": "string" }, "referredByCompanyId": { "type": "number" }, "tenantHost": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "reviewerId": { "type": "string" }, "website": { "type": "string" }, "logoUrl": { "type": "string" }, "logoStatus": { "type": "string", "nullable": true }, "logoCandidateUrl": { "type": "string", "nullable": true }, "logoCandidateDomain": { "type": "string", "nullable": true }, "logoSource": { "type": "string", "nullable": true }, "logoEvidence": { "type": "string", "nullable": true }, "logoReviewedByUserId": { "type": "string", "nullable": true }, "logoReviewedAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "statusUpdatedAt": { "type": "string", "format": "date-time" }, "employerPhaseOverride": { "type": "string" }, "trainingCommsSentAt": { "type": "string", "format": "date-time", "nullable": true }, "employeeInvitesProvisionedAt": { "type": "string", "format": "date-time", "nullable": true }, "employerIntroSentAt": { "type": "string", "format": "date-time", "nullable": true }, "defaultFolder": { "type": "number" }, "ranking": { "type": "number" }, "qualifiedLives": { "type": "number" }, "isATest": { "type": "number" }, "groupMaster": { "type": "number" }, "finalRefundAmount": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "hedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "group": { "type": "number", "nullable": true }, "feeHedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "stripeCustomerId": { "type": "string" }, "qbCustomerId": { "type": "string" }, "routingNumber": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "accountHolderName": { "type": "string", "nullable": true }, "bankName": { "type": "string" }, "clientAddress": { "type": "string" }, "affiliateUserId": { "type": "string", "nullable": true }, "salesRepId": { "type": "string", "nullable": true }, "affiliateManagerId": { "type": "string", "nullable": true }, "payrollDataMethod": { "type": "string", "nullable": true }, "payrollDataStatus": { "type": "string", "nullable": true }, "payrollDataStatusNote": { "type": "string", "nullable": true }, "payrollDataStatusUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollDataStatusUpdatedById": { "type": "string", "nullable": true }, "payrollSubmissionCompleteAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollSubmissionCompleteById": { "type": "string", "nullable": true }, "payrollProviderId": { "type": "string", "nullable": true }, "usesPeo": { "type": "boolean", "nullable": true }, "subAffiliateUserId": { "type": "string", "nullable": true }, "einNumber": { "type": "string" }, "businessEntityType": { "type": "string", "nullable": true }, "stateOfIncorporation": { "type": "string", "nullable": true }, "subSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubSubAffiliateUserId": { "type": "string", "nullable": true }, "referrerUserId": { "type": "string", "nullable": true }, "language": { "type": "string" }, "companyType": { "type": "string" }, "livesCount": { "type": "number", "nullable": true }, "hedgeFundBuyoutCompanyId": { "type": "number" }, "feeHedgeFundBuyoutCompanyId": { "type": "number" }, "subAffiliateCommissionFee": { "type": "number", "nullable": true }, "affiliateCommissionTierOverrideId": { "type": "number", "nullable": true }, "charityCompanyId": { "type": "number", "nullable": true }, "processorCompanyId": { "type": "number", "nullable": true }, "affiliateHasBeenReviewed": { "type": "number", "nullable": true }, "affiliateWillPayDownlines": { "type": "number", "nullable": true }, "bypassContract": { "type": "number", "nullable": true }, "charityPayoutPerLife": { "type": "number" }, "isMarketingPartner": { "type": "boolean" }, "autoEnrollEmployees": { "type": "boolean" }, "calcomBookingUrl": { "type": "string" }, "affiliateCommissionSetValue": { "type": "number" }, "affiliateAmount": { "type": "number" }, "salesRepAmount": { "type": "number" }, "affiliateManagerAmount": { "type": "number" }, "subAffiliateAmount": { "type": "number" }, "subSubAffiliateAmount": { "type": "number" }, "subSubSubAffiliateAmount": { "type": "number" }, "grossWellnessFee": { "type": "number" }, "referrer1Id": { "type": "string", "nullable": true }, "referrer2Id": { "type": "string", "nullable": true }, "referrer3Id": { "type": "string", "nullable": true }, "referrer4Id": { "type": "string", "nullable": true }, "referrer5Id": { "type": "string", "nullable": true }, "referrer6Id": { "type": "string", "nullable": true }, "tariffsPaid": { "type": "string" }, "tariffsPaidToCountries": { "type": "string" }, "tariffIndustry": { "type": "string" }, "tariffEntryMethod": { "type": "string" }, "tariffComission1": { "type": "number" }, "tariffComission2": { "type": "number" }, "tariffComission1Sub": { "type": "number" }, "tariffComission2Sub": { "type": "number" }, "referrer1Amount": { "type": "number" }, "referrer2Amount": { "type": "number" }, "referrer3Amount": { "type": "number" }, "referrer4Amount": { "type": "number" }, "referrer5Amount": { "type": "number" }, "referrer6Amount": { "type": "number" }, "w2Employees": { "type": "number" }, "numberOfReferrers": { "type": "number" }, "enrolledW2Employees": { "type": "number" }, "estimatedTariffIncome": { "type": "number" }, "quotedTariffIncome": { "type": "number" }, "contractedTariffIncome": { "type": "number" }, "campaignFromEmail": { "type": "string" }, "campaignFromName": { "type": "string" }, "campaignReplyTo": { "type": "string" }, "dealState": { "type": "string", "nullable": true }, "dealLostReason": { "type": "string", "nullable": true }, "dealLostNote": { "type": "string", "nullable": true }, "dealLostAt": { "type": "string", "format": "date-time", "nullable": true }, "dealLostById": { "type": "string", "nullable": true }, "dealRevivedAt": { "type": "string", "format": "date-time", "nullable": true }, "dealRevivedById": { "type": "string", "nullable": true }, "dealTerminalRaisedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedById": { "type": "string", "nullable": true }, "employerGroupId": { "type": "number", "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/MarshalledUser" }, "foreignKey": {}, "ownedBy": { "$ref": "#/components/schemas/MarshalledUser" }, "reviewedBy": { "$ref": "#/components/schemas/MarshalledUser" }, "hedgeFundBuyoutCompany": { "$ref": "#/components/schemas/Company" }, "feeHedgeFundBuyoutCompany": { "$ref": "#/components/schemas/Company" }, "clearErcUsers": { "type": "array", "items": { "$ref": "#/components/schemas/MarshalledUser" } }, "userCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/UserCompany" } } }, "additionalProperties": false, "x-typescript-type": "CompanyWithRelations" }, "NewCompany": { "title": "NewCompany", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCompany', exclude: [ 'id' ] })", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "expectedLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "goLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "address": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "bankAddress": { "type": "string" }, "bankCity": { "type": "string" }, "bankState": { "type": "string" }, "bankZipCode": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "createdByUserId": { "type": "string" }, "ownedById": { "type": "string" }, "referredByCompanyId": { "type": "number" }, "tenantHost": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "reviewerId": { "type": "string" }, "website": { "type": "string" }, "logoUrl": { "type": "string" }, "logoStatus": { "type": "string", "nullable": true }, "logoCandidateUrl": { "type": "string", "nullable": true }, "logoCandidateDomain": { "type": "string", "nullable": true }, "logoSource": { "type": "string", "nullable": true }, "logoEvidence": { "type": "string", "nullable": true }, "logoReviewedByUserId": { "type": "string", "nullable": true }, "logoReviewedAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "statusUpdatedAt": { "type": "string", "format": "date-time" }, "employerPhaseOverride": { "type": "string" }, "trainingCommsSentAt": { "type": "string", "format": "date-time", "nullable": true }, "employeeInvitesProvisionedAt": { "type": "string", "format": "date-time", "nullable": true }, "employerIntroSentAt": { "type": "string", "format": "date-time", "nullable": true }, "defaultFolder": { "type": "number" }, "ranking": { "type": "number" }, "qualifiedLives": { "type": "number" }, "isATest": { "type": "number" }, "groupMaster": { "type": "number" }, "finalRefundAmount": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "hedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "group": { "type": "number", "nullable": true }, "feeHedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "stripeCustomerId": { "type": "string" }, "qbCustomerId": { "type": "string" }, "routingNumber": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "accountHolderName": { "type": "string", "nullable": true }, "bankName": { "type": "string" }, "clientAddress": { "type": "string" }, "affiliateUserId": { "type": "string", "nullable": true }, "salesRepId": { "type": "string", "nullable": true }, "affiliateManagerId": { "type": "string", "nullable": true }, "payrollDataMethod": { "type": "string", "nullable": true }, "payrollDataStatus": { "type": "string", "nullable": true }, "payrollDataStatusNote": { "type": "string", "nullable": true }, "payrollDataStatusUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollDataStatusUpdatedById": { "type": "string", "nullable": true }, "payrollSubmissionCompleteAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollSubmissionCompleteById": { "type": "string", "nullable": true }, "payrollProviderId": { "type": "string", "nullable": true }, "usesPeo": { "type": "boolean", "nullable": true }, "subAffiliateUserId": { "type": "string", "nullable": true }, "einNumber": { "type": "string" }, "businessEntityType": { "type": "string", "nullable": true }, "stateOfIncorporation": { "type": "string", "nullable": true }, "subSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubSubAffiliateUserId": { "type": "string", "nullable": true }, "referrerUserId": { "type": "string", "nullable": true }, "language": { "type": "string" }, "companyType": { "type": "string" }, "livesCount": { "type": "number", "nullable": true }, "hedgeFundBuyoutCompanyId": { "type": "number" }, "feeHedgeFundBuyoutCompanyId": { "type": "number" }, "subAffiliateCommissionFee": { "type": "number", "nullable": true }, "affiliateCommissionTierOverrideId": { "type": "number", "nullable": true }, "charityCompanyId": { "type": "number", "nullable": true }, "processorCompanyId": { "type": "number", "nullable": true }, "affiliateHasBeenReviewed": { "type": "number", "nullable": true }, "affiliateWillPayDownlines": { "type": "number", "nullable": true }, "bypassContract": { "type": "number", "nullable": true }, "charityPayoutPerLife": { "type": "number" }, "isMarketingPartner": { "type": "boolean" }, "autoEnrollEmployees": { "type": "boolean" }, "calcomBookingUrl": { "type": "string" }, "affiliateCommissionSetValue": { "type": "number" }, "affiliateAmount": { "type": "number" }, "salesRepAmount": { "type": "number" }, "affiliateManagerAmount": { "type": "number" }, "subAffiliateAmount": { "type": "number" }, "subSubAffiliateAmount": { "type": "number" }, "subSubSubAffiliateAmount": { "type": "number" }, "grossWellnessFee": { "type": "number" }, "referrer1Id": { "type": "string", "nullable": true }, "referrer2Id": { "type": "string", "nullable": true }, "referrer3Id": { "type": "string", "nullable": true }, "referrer4Id": { "type": "string", "nullable": true }, "referrer5Id": { "type": "string", "nullable": true }, "referrer6Id": { "type": "string", "nullable": true }, "tariffsPaid": { "type": "string" }, "tariffsPaidToCountries": { "type": "string" }, "tariffIndustry": { "type": "string" }, "tariffEntryMethod": { "type": "string" }, "tariffComission1": { "type": "number" }, "tariffComission2": { "type": "number" }, "tariffComission1Sub": { "type": "number" }, "tariffComission2Sub": { "type": "number" }, "referrer1Amount": { "type": "number" }, "referrer2Amount": { "type": "number" }, "referrer3Amount": { "type": "number" }, "referrer4Amount": { "type": "number" }, "referrer5Amount": { "type": "number" }, "referrer6Amount": { "type": "number" }, "w2Employees": { "type": "number" }, "numberOfReferrers": { "type": "number" }, "enrolledW2Employees": { "type": "number" }, "estimatedTariffIncome": { "type": "number" }, "quotedTariffIncome": { "type": "number" }, "contractedTariffIncome": { "type": "number" }, "campaignFromEmail": { "type": "string" }, "campaignFromName": { "type": "string" }, "campaignReplyTo": { "type": "string" }, "dealState": { "type": "string", "nullable": true }, "dealLostReason": { "type": "string", "nullable": true }, "dealLostNote": { "type": "string", "nullable": true }, "dealLostAt": { "type": "string", "format": "date-time", "nullable": true }, "dealLostById": { "type": "string", "nullable": true }, "dealRevivedAt": { "type": "string", "format": "date-time", "nullable": true }, "dealRevivedById": { "type": "string", "nullable": true }, "dealTerminalRaisedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedById": { "type": "string", "nullable": true }, "employerGroupId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "CompanyPartial": { "title": "CompanyPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "expectedLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "goLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "address": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "bankAddress": { "type": "string" }, "bankCity": { "type": "string" }, "bankState": { "type": "string" }, "bankZipCode": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "createdByUserId": { "type": "string" }, "ownedById": { "type": "string" }, "referredByCompanyId": { "type": "number" }, "tenantHost": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "reviewerId": { "type": "string" }, "website": { "type": "string" }, "logoUrl": { "type": "string" }, "logoStatus": { "type": "string", "nullable": true }, "logoCandidateUrl": { "type": "string", "nullable": true }, "logoCandidateDomain": { "type": "string", "nullable": true }, "logoSource": { "type": "string", "nullable": true }, "logoEvidence": { "type": "string", "nullable": true }, "logoReviewedByUserId": { "type": "string", "nullable": true }, "logoReviewedAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "statusUpdatedAt": { "type": "string", "format": "date-time" }, "employerPhaseOverride": { "type": "string" }, "trainingCommsSentAt": { "type": "string", "format": "date-time", "nullable": true }, "employeeInvitesProvisionedAt": { "type": "string", "format": "date-time", "nullable": true }, "employerIntroSentAt": { "type": "string", "format": "date-time", "nullable": true }, "defaultFolder": { "type": "number" }, "ranking": { "type": "number" }, "qualifiedLives": { "type": "number" }, "isATest": { "type": "number" }, "groupMaster": { "type": "number" }, "finalRefundAmount": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "hedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "group": { "type": "number", "nullable": true }, "feeHedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "stripeCustomerId": { "type": "string" }, "qbCustomerId": { "type": "string" }, "routingNumber": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "accountHolderName": { "type": "string", "nullable": true }, "bankName": { "type": "string" }, "clientAddress": { "type": "string" }, "affiliateUserId": { "type": "string", "nullable": true }, "salesRepId": { "type": "string", "nullable": true }, "affiliateManagerId": { "type": "string", "nullable": true }, "payrollDataMethod": { "type": "string", "nullable": true }, "payrollDataStatus": { "type": "string", "nullable": true }, "payrollDataStatusNote": { "type": "string", "nullable": true }, "payrollDataStatusUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollDataStatusUpdatedById": { "type": "string", "nullable": true }, "payrollSubmissionCompleteAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollSubmissionCompleteById": { "type": "string", "nullable": true }, "payrollProviderId": { "type": "string", "nullable": true }, "usesPeo": { "type": "boolean", "nullable": true }, "subAffiliateUserId": { "type": "string", "nullable": true }, "einNumber": { "type": "string" }, "businessEntityType": { "type": "string", "nullable": true }, "stateOfIncorporation": { "type": "string", "nullable": true }, "subSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubSubAffiliateUserId": { "type": "string", "nullable": true }, "referrerUserId": { "type": "string", "nullable": true }, "language": { "type": "string" }, "companyType": { "type": "string" }, "livesCount": { "type": "number", "nullable": true }, "hedgeFundBuyoutCompanyId": { "type": "number" }, "feeHedgeFundBuyoutCompanyId": { "type": "number" }, "subAffiliateCommissionFee": { "type": "number", "nullable": true }, "affiliateCommissionTierOverrideId": { "type": "number", "nullable": true }, "charityCompanyId": { "type": "number", "nullable": true }, "processorCompanyId": { "type": "number", "nullable": true }, "affiliateHasBeenReviewed": { "type": "number", "nullable": true }, "affiliateWillPayDownlines": { "type": "number", "nullable": true }, "bypassContract": { "type": "number", "nullable": true }, "charityPayoutPerLife": { "type": "number" }, "isMarketingPartner": { "type": "boolean" }, "autoEnrollEmployees": { "type": "boolean" }, "calcomBookingUrl": { "type": "string" }, "affiliateCommissionSetValue": { "type": "number" }, "affiliateAmount": { "type": "number" }, "salesRepAmount": { "type": "number" }, "affiliateManagerAmount": { "type": "number" }, "subAffiliateAmount": { "type": "number" }, "subSubAffiliateAmount": { "type": "number" }, "subSubSubAffiliateAmount": { "type": "number" }, "grossWellnessFee": { "type": "number" }, "referrer1Id": { "type": "string", "nullable": true }, "referrer2Id": { "type": "string", "nullable": true }, "referrer3Id": { "type": "string", "nullable": true }, "referrer4Id": { "type": "string", "nullable": true }, "referrer5Id": { "type": "string", "nullable": true }, "referrer6Id": { "type": "string", "nullable": true }, "tariffsPaid": { "type": "string" }, "tariffsPaidToCountries": { "type": "string" }, "tariffIndustry": { "type": "string" }, "tariffEntryMethod": { "type": "string" }, "tariffComission1": { "type": "number" }, "tariffComission2": { "type": "number" }, "tariffComission1Sub": { "type": "number" }, "tariffComission2Sub": { "type": "number" }, "referrer1Amount": { "type": "number" }, "referrer2Amount": { "type": "number" }, "referrer3Amount": { "type": "number" }, "referrer4Amount": { "type": "number" }, "referrer5Amount": { "type": "number" }, "referrer6Amount": { "type": "number" }, "w2Employees": { "type": "number" }, "numberOfReferrers": { "type": "number" }, "enrolledW2Employees": { "type": "number" }, "estimatedTariffIncome": { "type": "number" }, "quotedTariffIncome": { "type": "number" }, "contractedTariffIncome": { "type": "number" }, "campaignFromEmail": { "type": "string" }, "campaignFromName": { "type": "string" }, "campaignReplyTo": { "type": "string" }, "dealState": { "type": "string", "nullable": true }, "dealLostReason": { "type": "string", "nullable": true }, "dealLostNote": { "type": "string", "nullable": true }, "dealLostAt": { "type": "string", "format": "date-time", "nullable": true }, "dealLostById": { "type": "string", "nullable": true }, "dealRevivedAt": { "type": "string", "format": "date-time", "nullable": true }, "dealRevivedById": { "type": "string", "nullable": true }, "dealTerminalRaisedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedById": { "type": "string", "nullable": true }, "employerGroupId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CommissionChange": { "title": "CommissionChange", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "previousAmount": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "changedBy": { "type": "string", "nullable": true }, "changeType": { "type": "string", "nullable": true }, "newAmount": { "type": "number", "nullable": true }, "dateChanged": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "NewCommissionChange": { "title": "NewCommissionChange", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCommissionChange', exclude: [ 'id' ] })", "properties": { "previousAmount": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "changedBy": { "type": "string", "nullable": true }, "changeType": { "type": "string", "nullable": true }, "newAmount": { "type": "number", "nullable": true }, "dateChanged": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "CommissionChangeWithRelations": { "title": "CommissionChangeWithRelations", "type": "object", "description": "(tsType: CommissionChangeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "previousAmount": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "changedBy": { "type": "string", "nullable": true }, "changeType": { "type": "string", "nullable": true }, "newAmount": { "type": "number", "nullable": true }, "dateChanged": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "CommissionChangeWithRelations" }, "CommissionChangePartial": { "title": "CommissionChangePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "previousAmount": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "changedBy": { "type": "string", "nullable": true }, "changeType": { "type": "string", "nullable": true }, "newAmount": { "type": "number", "nullable": true }, "dateChanged": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ClosureLikelihoodTypes": { "title": "ClosureLikelihoodTypes", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "percentage": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewClosureLikelihoodTypes": { "title": "NewClosureLikelihoodTypes", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewClosureLikelihoodTypes', exclude: [ 'id' ] })", "properties": { "name": { "type": "string", "nullable": true }, "percentage": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ClosureLikelihoodTypesWithRelations": { "title": "ClosureLikelihoodTypesWithRelations", "type": "object", "description": "(tsType: ClosureLikelihoodTypesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "percentage": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "ClosureLikelihoodTypesWithRelations" }, "ClosureLikelihoodTypesPartial": { "title": "ClosureLikelihoodTypesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "percentage": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ClosureLikelihoodEntries": { "title": "ClosureLikelihoodEntries", "type": "object", "properties": { "companyId": { "type": "number", "nullable": true }, "dateUpdated": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "number", "nullable": false }, "likelihoodTypeId": { "type": "number", "nullable": true }, "userIdUpdatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewClosureLikelihoodEntries": { "title": "NewClosureLikelihoodEntries", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewClosureLikelihoodEntries', exclude: [ 'id' ] })", "properties": { "companyId": { "type": "number", "nullable": true }, "dateUpdated": { "type": "string", "format": "date-time", "nullable": true }, "likelihoodTypeId": { "type": "number", "nullable": true }, "userIdUpdatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ClosureLikelihoodEntriesWithRelations": { "title": "ClosureLikelihoodEntriesWithRelations", "type": "object", "description": "(tsType: ClosureLikelihoodEntriesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "companyId": { "type": "number", "nullable": true }, "dateUpdated": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "number", "nullable": false }, "likelihoodTypeId": { "type": "number", "nullable": true }, "userIdUpdatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "ClosureLikelihoodEntriesWithRelations" }, "ClosureLikelihoodEntriesPartial": { "title": "ClosureLikelihoodEntriesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "companyId": { "type": "number", "nullable": true }, "dateUpdated": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "number", "nullable": false }, "likelihoodTypeId": { "type": "number", "nullable": true }, "userIdUpdatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ClientStatuses": { "title": "ClientStatuses", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "requiredRoles": { "type": "string" }, "mondayId": { "type": "string" }, "order": { "type": "number" }, "level": { "type": "number" }, "parent": { "type": "number" } }, "required": [ "id", "level" ], "additionalProperties": false }, "NewClientStatuses": { "title": "NewClientStatuses", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewClientStatuses', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "requiredRoles": { "type": "string" }, "mondayId": { "type": "string" }, "order": { "type": "number" }, "level": { "type": "number" }, "parent": { "type": "number" } }, "required": [ "level" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ClientStatusesWithRelations": { "title": "ClientStatusesWithRelations", "type": "object", "description": "(tsType: ClientStatusesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "requiredRoles": { "type": "string" }, "mondayId": { "type": "string" }, "order": { "type": "number" }, "level": { "type": "number" }, "parent": { "type": "number" } }, "required": [ "id", "level" ], "additionalProperties": false, "x-typescript-type": "ClientStatusesWithRelations" }, "ClientStatusesPartial": { "title": "ClientStatusesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "requiredRoles": { "type": "string" }, "mondayId": { "type": "string" }, "order": { "type": "number" }, "level": { "type": "number" }, "parent": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Device": { "title": "Device", "type": "object", "properties": { "id": { "type": "number" }, "deviceUuid": { "type": "string" }, "userId": { "type": "string" }, "label": { "type": "string" }, "platform": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastSeenAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time" } }, "required": [ "deviceUuid", "userId" ], "additionalProperties": false }, "NewUser": { "title": "NewUser", "type": "object", "description": "(tsType: NewUserRequest, schemaOptions: { title: 'NewUser' }), , , {\"indexInfo\":{\"email\":{\"unique\":false},\"username\":{\"username\":{\"unique\":true}},\"userKind\":{\"userKind\":{\"unique\":false}}}}", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "invitedAt": { "type": "string", "format": "date-time" }, "accountSetupAt": { "type": "string", "format": "date-time" }, "inviteSentAt": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string" }, "company": { "type": "number" }, "defaultProcessflowId": { "type": "number" }, "closerId": { "type": "string" }, "cpaUserId": { "type": "string" }, "accountManagerUserId": { "type": "string" }, "affiliateUserId": { "type": "string" }, "docCollectorId": { "type": "string" }, "affiliateDetails": { "type": "string" }, "taxAttorneyUserId": { "type": "string" }, "lastLoggedIn": { "type": "string", "format": "date-time" }, "isTempPassword": { "type": "boolean" }, "userStatus": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "utm": { "type": "string" }, "emailVerified": { "type": "boolean" }, "realm": { "type": "string" }, "stPass": { "type": "string" }, "stCompany": { "type": "number" }, "lastLoginHost": { "type": "string" }, "stUrl": { "type": "string" }, "verificationToken": { "type": "string" }, "passwordResetExpiresAt": { "type": "string", "format": "date-time" }, "pf7percentage": { "type": "number" }, "clientStatus": { "type": "number" }, "notificationConsentAt": { "type": "string", "format": "date-time" }, "termsVersionAccepted": { "type": "string" }, "notificationCategoryConsent": { "type": "string" }, "pushEnabled": { "type": "boolean" }, "notificationConsentIp": { "type": "string" }, "notificationConsentName": { "type": "string" }, "registrationIp": { "type": "string" }, "registrationLocation": { "type": "string" }, "smsOptedOut": { "type": "boolean" }, "smsOptedOutAt": { "type": "string", "format": "date-time" }, "smsSendTimezone": { "type": "string" }, "smsLastDigestAt": { "type": "string", "format": "date-time" }, "notificationDigestFrequency": { "type": "string", "enum": [ "daily", "weekly" ] }, "emailLastDigestAt": { "type": "string", "format": "date-time" }, "image": { "type": "string", "nullable": true }, "userKind": { "type": "string" }, "estimatedW2Employees2020": { "type": "number" }, "estimatedW2Employees2021": { "type": "number" }, "site": { "type": "string" }, "companyName": { "type": "string" }, "turnstileToken": { "type": "string" } }, "required": [ "password", "email", "username" ], "additionalProperties": false, "x-typescript-type": "NewUserRequest" }, "NewUserRequest": { "title": "NewUserRequest", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "invitedAt": { "type": "string", "format": "date-time" }, "accountSetupAt": { "type": "string", "format": "date-time" }, "inviteSentAt": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string" }, "company": { "type": "number" }, "defaultProcessflowId": { "type": "number" }, "closerId": { "type": "string" }, "cpaUserId": { "type": "string" }, "accountManagerUserId": { "type": "string" }, "affiliateUserId": { "type": "string" }, "docCollectorId": { "type": "string" }, "affiliateDetails": { "type": "string" }, "taxAttorneyUserId": { "type": "string" }, "lastLoggedIn": { "type": "string", "format": "date-time" }, "isTempPassword": { "type": "boolean" }, "userStatus": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "utm": { "type": "string" }, "emailVerified": { "type": "boolean" }, "realm": { "type": "string" }, "stPass": { "type": "string" }, "stCompany": { "type": "number" }, "lastLoginHost": { "type": "string" }, "stUrl": { "type": "string" }, "verificationToken": { "type": "string" }, "passwordResetExpiresAt": { "type": "string", "format": "date-time" }, "pf7percentage": { "type": "number" }, "clientStatus": { "type": "number" }, "notificationConsentAt": { "type": "string", "format": "date-time" }, "termsVersionAccepted": { "type": "string" }, "notificationCategoryConsent": { "type": "string" }, "pushEnabled": { "type": "boolean" }, "notificationConsentIp": { "type": "string" }, "notificationConsentName": { "type": "string" }, "registrationIp": { "type": "string" }, "registrationLocation": { "type": "string" }, "smsOptedOut": { "type": "boolean" }, "smsOptedOutAt": { "type": "string", "format": "date-time" }, "smsSendTimezone": { "type": "string" }, "smsLastDigestAt": { "type": "string", "format": "date-time" }, "notificationDigestFrequency": { "type": "string", "enum": [ "daily", "weekly" ] }, "emailLastDigestAt": { "type": "string", "format": "date-time" }, "image": { "type": "string", "nullable": true }, "userKind": { "type": "string" }, "estimatedW2Employees2020": { "type": "number" }, "estimatedW2Employees2021": { "type": "number" }, "site": { "type": "string" }, "companyName": { "type": "string" }, "turnstileToken": { "type": "string" } }, "required": [ "password", "email", "username" ], "description": "{\"indexInfo\":{\"email\":{\"unique\":false},\"username\":{\"username\":{\"unique\":true}},\"userKind\":{\"userKind\":{\"unique\":false}}}}", "additionalProperties": false }, "NewTariffUser": { "title": "NewTariffUser", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n title: 'NewTariffUser',\n exclude: [\n 'id', 'createdAt',\n 'updatedAt', 'invitedAt',\n 'accountSetupAt', 'createdByUserId',\n 'company', 'password',\n 'defaultProcessflowId', 'closerId',\n 'cpaUserId', 'accountManagerUserId',\n 'affiliateUserId', 'docCollectorId',\n 'affiliateDetails', 'taxAttorneyUserId',\n 'lastLoggedIn', 'estimatedW2Employees2020',\n 'estimatedW2Employees2021', 'isTempPassword',\n 'userStatus', 'emailVerified',\n 'realm', 'stPass',\n 'stCompany', 'stUrl',\n 'verificationToken', 'pf7percentage'\n ]\n}), , , {\"indexInfo\":{\"email\":{\"unique\":false},\"username\":{\"username\":{\"unique\":true}},\"userKind\":{\"userKind\":{\"unique\":false}}}}", "properties": { "inviteSentAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "utm": { "type": "string" }, "lastLoginHost": { "type": "string" }, "passwordResetExpiresAt": { "type": "string", "format": "date-time" }, "clientStatus": { "type": "number" }, "notificationConsentAt": { "type": "string", "format": "date-time" }, "termsVersionAccepted": { "type": "string" }, "notificationCategoryConsent": { "type": "string" }, "pushEnabled": { "type": "boolean" }, "notificationConsentIp": { "type": "string" }, "notificationConsentName": { "type": "string" }, "registrationIp": { "type": "string" }, "registrationLocation": { "type": "string" }, "smsOptedOut": { "type": "boolean" }, "smsOptedOutAt": { "type": "string", "format": "date-time" }, "smsSendTimezone": { "type": "string" }, "smsLastDigestAt": { "type": "string", "format": "date-time" }, "notificationDigestFrequency": { "type": "string", "enum": [ "daily", "weekly" ] }, "emailLastDigestAt": { "type": "string", "format": "date-time" }, "image": { "type": "string", "nullable": true }, "userKind": { "type": "string" }, "tariffIndustry": { "type": "string" }, "tariffEntryMethod": { "type": "string" }, "tariffsPaidToCountries": { "type": "string" }, "tariffsPaidToIndustries": { "type": "string" }, "tariffsPaid": { "type": "string" } }, "required": [ "email" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "NewTariffUserRequest": { "title": "NewTariffUserRequest", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "invitedAt": { "type": "string", "format": "date-time" }, "accountSetupAt": { "type": "string", "format": "date-time" }, "inviteSentAt": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string" }, "company": { "type": "number" }, "defaultProcessflowId": { "type": "number" }, "closerId": { "type": "string" }, "cpaUserId": { "type": "string" }, "accountManagerUserId": { "type": "string" }, "affiliateUserId": { "type": "string" }, "docCollectorId": { "type": "string" }, "affiliateDetails": { "type": "string" }, "taxAttorneyUserId": { "type": "string" }, "lastLoggedIn": { "type": "string", "format": "date-time" }, "isTempPassword": { "type": "boolean" }, "userStatus": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "utm": { "type": "string" }, "emailVerified": { "type": "boolean" }, "realm": { "type": "string" }, "stPass": { "type": "string" }, "stCompany": { "type": "number" }, "lastLoginHost": { "type": "string" }, "stUrl": { "type": "string" }, "verificationToken": { "type": "string" }, "passwordResetExpiresAt": { "type": "string", "format": "date-time" }, "pf7percentage": { "type": "number" }, "clientStatus": { "type": "number" }, "notificationConsentAt": { "type": "string", "format": "date-time" }, "termsVersionAccepted": { "type": "string" }, "notificationCategoryConsent": { "type": "string" }, "pushEnabled": { "type": "boolean" }, "notificationConsentIp": { "type": "string" }, "notificationConsentName": { "type": "string" }, "registrationIp": { "type": "string" }, "registrationLocation": { "type": "string" }, "smsOptedOut": { "type": "boolean" }, "smsOptedOutAt": { "type": "string", "format": "date-time" }, "smsSendTimezone": { "type": "string" }, "smsLastDigestAt": { "type": "string", "format": "date-time" }, "notificationDigestFrequency": { "type": "string", "enum": [ "daily", "weekly" ] }, "emailLastDigestAt": { "type": "string", "format": "date-time" }, "image": { "type": "string", "nullable": true }, "userKind": { "type": "string" }, "tariffIndustry": { "type": "string" }, "tariffEntryMethod": { "type": "string" }, "tariffsPaidToCountries": { "type": "string" }, "tariffsPaidToIndustries": { "type": "string" }, "tariffsPaid": { "type": "string" } }, "description": "{\"indexInfo\":{\"email\":{\"unique\":false},\"username\":{\"username\":{\"unique\":true}},\"userKind\":{\"userKind\":{\"unique\":false}}}}", "required": [ "email" ], "additionalProperties": false }, "UserPartial": { "title": "UserPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true }), {\"indexInfo\":{\"email\":{\"unique\":true}}}", "properties": { "id": { "type": "string" }, "realm": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean" }, "verificationToken": { "type": "string" } }, "additionalProperties": true, "x-typescript-type": "Partial" }, "User": { "title": "User", "type": "object", "properties": { "id": { "type": "string" }, "realm": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean" }, "verificationToken": { "type": "string" } }, "description": "{\"indexInfo\":{\"email\":{\"unique\":true}}}", "required": [ "email" ], "additionalProperties": true }, "ClearErcUserExcluding_password-verificationToken-stPass_": { "title": "ClearErcUserExcluding_password-verificationToken-stPass_", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'password', 'verificationToken', 'stPass' ] }), , , {\"indexInfo\":{\"email\":{\"unique\":false},\"username\":{\"username\":{\"unique\":true}},\"userKind\":{\"userKind\":{\"unique\":false}}}}", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "invitedAt": { "type": "string", "format": "date-time" }, "accountSetupAt": { "type": "string", "format": "date-time" }, "inviteSentAt": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string" }, "company": { "type": "number" }, "defaultProcessflowId": { "type": "number" }, "closerId": { "type": "string" }, "cpaUserId": { "type": "string" }, "accountManagerUserId": { "type": "string" }, "affiliateUserId": { "type": "string" }, "docCollectorId": { "type": "string" }, "affiliateDetails": { "type": "string" }, "taxAttorneyUserId": { "type": "string" }, "lastLoggedIn": { "type": "string", "format": "date-time" }, "isTempPassword": { "type": "boolean" }, "userStatus": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "utm": { "type": "string" }, "emailVerified": { "type": "boolean" }, "realm": { "type": "string" }, "stCompany": { "type": "number" }, "lastLoginHost": { "type": "string" }, "stUrl": { "type": "string" }, "passwordResetExpiresAt": { "type": "string", "format": "date-time" }, "pf7percentage": { "type": "number" }, "clientStatus": { "type": "number" }, "notificationConsentAt": { "type": "string", "format": "date-time" }, "termsVersionAccepted": { "type": "string" }, "notificationCategoryConsent": { "type": "string" }, "pushEnabled": { "type": "boolean" }, "notificationConsentIp": { "type": "string" }, "notificationConsentName": { "type": "string" }, "registrationIp": { "type": "string" }, "registrationLocation": { "type": "string" }, "smsOptedOut": { "type": "boolean" }, "smsOptedOutAt": { "type": "string", "format": "date-time" }, "smsSendTimezone": { "type": "string" }, "smsLastDigestAt": { "type": "string", "format": "date-time" }, "notificationDigestFrequency": { "type": "string", "enum": [ "daily", "weekly" ] }, "emailLastDigestAt": { "type": "string", "format": "date-time" }, "image": { "type": "string", "nullable": true }, "userKind": { "type": "string" } }, "required": [ "email", "username" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "RoleGroupsExcluding_password-verificationToken-stPass_": { "title": "RoleGroupsExcluding_password-verificationToken-stPass_", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'password', 'verificationToken', 'stPass' ] })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "owner": { "type": "number" }, "isPublic": { "type": "number" }, "isForCompany": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "CompanyExcluding_password-verificationToken-stPass_": { "title": "CompanyExcluding_password-verificationToken-stPass_", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'password', 'verificationToken', 'stPass' ] })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "expectedLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "goLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "address": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "bankAddress": { "type": "string" }, "bankCity": { "type": "string" }, "bankState": { "type": "string" }, "bankZipCode": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "createdByUserId": { "type": "string" }, "ownedById": { "type": "string" }, "referredByCompanyId": { "type": "number" }, "tenantHost": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "reviewerId": { "type": "string" }, "website": { "type": "string" }, "logoUrl": { "type": "string" }, "logoStatus": { "type": "string", "nullable": true }, "logoCandidateUrl": { "type": "string", "nullable": true }, "logoCandidateDomain": { "type": "string", "nullable": true }, "logoSource": { "type": "string", "nullable": true }, "logoEvidence": { "type": "string", "nullable": true }, "logoReviewedByUserId": { "type": "string", "nullable": true }, "logoReviewedAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "statusUpdatedAt": { "type": "string", "format": "date-time" }, "employerPhaseOverride": { "type": "string" }, "trainingCommsSentAt": { "type": "string", "format": "date-time", "nullable": true }, "employeeInvitesProvisionedAt": { "type": "string", "format": "date-time", "nullable": true }, "employerIntroSentAt": { "type": "string", "format": "date-time", "nullable": true }, "defaultFolder": { "type": "number" }, "ranking": { "type": "number" }, "qualifiedLives": { "type": "number" }, "isATest": { "type": "number" }, "groupMaster": { "type": "number" }, "finalRefundAmount": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "hedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "group": { "type": "number", "nullable": true }, "feeHedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "stripeCustomerId": { "type": "string" }, "qbCustomerId": { "type": "string" }, "routingNumber": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "accountHolderName": { "type": "string", "nullable": true }, "bankName": { "type": "string" }, "clientAddress": { "type": "string" }, "affiliateUserId": { "type": "string", "nullable": true }, "salesRepId": { "type": "string", "nullable": true }, "affiliateManagerId": { "type": "string", "nullable": true }, "payrollDataMethod": { "type": "string", "nullable": true }, "payrollDataStatus": { "type": "string", "nullable": true }, "payrollDataStatusNote": { "type": "string", "nullable": true }, "payrollDataStatusUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollDataStatusUpdatedById": { "type": "string", "nullable": true }, "payrollSubmissionCompleteAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollSubmissionCompleteById": { "type": "string", "nullable": true }, "payrollProviderId": { "type": "string", "nullable": true }, "usesPeo": { "type": "boolean", "nullable": true }, "subAffiliateUserId": { "type": "string", "nullable": true }, "einNumber": { "type": "string" }, "businessEntityType": { "type": "string", "nullable": true }, "stateOfIncorporation": { "type": "string", "nullable": true }, "subSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubSubAffiliateUserId": { "type": "string", "nullable": true }, "referrerUserId": { "type": "string", "nullable": true }, "language": { "type": "string" }, "companyType": { "type": "string" }, "livesCount": { "type": "number", "nullable": true }, "hedgeFundBuyoutCompanyId": { "type": "number" }, "feeHedgeFundBuyoutCompanyId": { "type": "number" }, "subAffiliateCommissionFee": { "type": "number", "nullable": true }, "affiliateCommissionTierOverrideId": { "type": "number", "nullable": true }, "charityCompanyId": { "type": "number", "nullable": true }, "processorCompanyId": { "type": "number", "nullable": true }, "affiliateHasBeenReviewed": { "type": "number", "nullable": true }, "affiliateWillPayDownlines": { "type": "number", "nullable": true }, "bypassContract": { "type": "number", "nullable": true }, "charityPayoutPerLife": { "type": "number" }, "isMarketingPartner": { "type": "boolean" }, "autoEnrollEmployees": { "type": "boolean" }, "calcomBookingUrl": { "type": "string" }, "affiliateCommissionSetValue": { "type": "number" }, "affiliateAmount": { "type": "number" }, "salesRepAmount": { "type": "number" }, "affiliateManagerAmount": { "type": "number" }, "subAffiliateAmount": { "type": "number" }, "subSubAffiliateAmount": { "type": "number" }, "subSubSubAffiliateAmount": { "type": "number" }, "grossWellnessFee": { "type": "number" }, "referrer1Id": { "type": "string", "nullable": true }, "referrer2Id": { "type": "string", "nullable": true }, "referrer3Id": { "type": "string", "nullable": true }, "referrer4Id": { "type": "string", "nullable": true }, "referrer5Id": { "type": "string", "nullable": true }, "referrer6Id": { "type": "string", "nullable": true }, "tariffsPaid": { "type": "string" }, "tariffsPaidToCountries": { "type": "string" }, "tariffIndustry": { "type": "string" }, "tariffEntryMethod": { "type": "string" }, "tariffComission1": { "type": "number" }, "tariffComission2": { "type": "number" }, "tariffComission1Sub": { "type": "number" }, "tariffComission2Sub": { "type": "number" }, "referrer1Amount": { "type": "number" }, "referrer2Amount": { "type": "number" }, "referrer3Amount": { "type": "number" }, "referrer4Amount": { "type": "number" }, "referrer5Amount": { "type": "number" }, "referrer6Amount": { "type": "number" }, "w2Employees": { "type": "number" }, "numberOfReferrers": { "type": "number" }, "enrolledW2Employees": { "type": "number" }, "estimatedTariffIncome": { "type": "number" }, "quotedTariffIncome": { "type": "number" }, "contractedTariffIncome": { "type": "number" }, "campaignFromEmail": { "type": "string" }, "campaignFromName": { "type": "string" }, "campaignReplyTo": { "type": "string" }, "dealState": { "type": "string", "nullable": true }, "dealLostReason": { "type": "string", "nullable": true }, "dealLostNote": { "type": "string", "nullable": true }, "dealLostAt": { "type": "string", "format": "date-time", "nullable": true }, "dealLostById": { "type": "string", "nullable": true }, "dealRevivedAt": { "type": "string", "format": "date-time", "nullable": true }, "dealRevivedById": { "type": "string", "nullable": true }, "dealTerminalRaisedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedById": { "type": "string", "nullable": true }, "employerGroupId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UserCompanyExcluding_password-verificationToken-stPass_": { "title": "UserCompanyExcluding_password-verificationToken-stPass_", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'password', 'verificationToken', 'stPass' ] })", "properties": { "commissionPercentage": { "type": "number" }, "id": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time" }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time" }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time" }, "inviteDispatchedAt": { "type": "string", "format": "date-time" }, "ercUserId": { "type": "string" }, "companyId": { "type": "number" }, "roleGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "MarshalledUserWithRelations": { "title": "MarshalledUserWithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'MarshalledUserWithRelations', exclude: [ 'password', 'verificationToken', 'stPass' ], includeRelations: true }), , , {\"indexInfo\":{\"email\":{\"unique\":false},\"username\":{\"username\":{\"unique\":true}},\"userKind\":{\"userKind\":{\"unique\":false}}}}", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "invitedAt": { "type": "string", "format": "date-time" }, "accountSetupAt": { "type": "string", "format": "date-time" }, "inviteSentAt": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string" }, "company": { "type": "number" }, "defaultProcessflowId": { "type": "number" }, "closerId": { "type": "string" }, "cpaUserId": { "type": "string" }, "accountManagerUserId": { "type": "string" }, "affiliateUserId": { "type": "string" }, "docCollectorId": { "type": "string" }, "affiliateDetails": { "type": "string" }, "taxAttorneyUserId": { "type": "string" }, "lastLoggedIn": { "type": "string", "format": "date-time" }, "isTempPassword": { "type": "boolean" }, "userStatus": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "utm": { "type": "string" }, "emailVerified": { "type": "boolean" }, "realm": { "type": "string" }, "stCompany": { "type": "number" }, "lastLoginHost": { "type": "string" }, "stUrl": { "type": "string" }, "passwordResetExpiresAt": { "type": "string", "format": "date-time" }, "pf7percentage": { "type": "number" }, "clientStatus": { "type": "number" }, "notificationConsentAt": { "type": "string", "format": "date-time" }, "termsVersionAccepted": { "type": "string" }, "notificationCategoryConsent": { "type": "string" }, "pushEnabled": { "type": "boolean" }, "notificationConsentIp": { "type": "string" }, "notificationConsentName": { "type": "string" }, "registrationIp": { "type": "string" }, "registrationLocation": { "type": "string" }, "smsOptedOut": { "type": "boolean" }, "smsOptedOutAt": { "type": "string", "format": "date-time" }, "smsSendTimezone": { "type": "string" }, "smsLastDigestAt": { "type": "string", "format": "date-time" }, "notificationDigestFrequency": { "type": "string", "enum": [ "daily", "weekly" ] }, "emailLastDigestAt": { "type": "string", "format": "date-time" }, "image": { "type": "string", "nullable": true }, "userKind": { "type": "string" }, "affiliateUser": { "$ref": "#/components/schemas/ClearErcUserExcluding_password-verificationToken-stPass_" }, "roleGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RoleGroupsExcluding_password-verificationToken-stPass_" } }, "companyRoleGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RoleGroupsExcluding_password-verificationToken-stPass_" } }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyExcluding_password-verificationToken-stPass_" } }, "userCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/UserCompanyExcluding_password-verificationToken-stPass_" } }, "affiliateUsers": { "type": "array", "items": { "$ref": "#/components/schemas/ClearErcUserExcluding_password-verificationToken-stPass_" } }, "hasPassword": { "type": "boolean", "description": "Whether this account has a login password set at all. Derived from the (never-published) password hash — see accountHasPassword. False for accounts created without one (invite / magic-link / pre-signup wizard), which is what the \"set a password\" surface keys off." } }, "required": [ "email", "username" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ClearErcUser": { "title": "ClearErcUser", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "invitedAt": { "type": "string", "format": "date-time" }, "accountSetupAt": { "type": "string", "format": "date-time" }, "inviteSentAt": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string" }, "company": { "type": "number" }, "defaultProcessflowId": { "type": "number" }, "closerId": { "type": "string" }, "cpaUserId": { "type": "string" }, "accountManagerUserId": { "type": "string" }, "affiliateUserId": { "type": "string" }, "docCollectorId": { "type": "string" }, "affiliateDetails": { "type": "string" }, "taxAttorneyUserId": { "type": "string" }, "lastLoggedIn": { "type": "string", "format": "date-time" }, "isTempPassword": { "type": "boolean" }, "userStatus": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "utm": { "type": "string" }, "emailVerified": { "type": "boolean" }, "realm": { "type": "string" }, "stPass": { "type": "string" }, "stCompany": { "type": "number" }, "lastLoginHost": { "type": "string" }, "stUrl": { "type": "string" }, "verificationToken": { "type": "string" }, "passwordResetExpiresAt": { "type": "string", "format": "date-time" }, "pf7percentage": { "type": "number" }, "clientStatus": { "type": "number" }, "notificationConsentAt": { "type": "string", "format": "date-time" }, "termsVersionAccepted": { "type": "string" }, "notificationCategoryConsent": { "type": "string" }, "pushEnabled": { "type": "boolean" }, "notificationConsentIp": { "type": "string" }, "notificationConsentName": { "type": "string" }, "registrationIp": { "type": "string" }, "registrationLocation": { "type": "string" }, "smsOptedOut": { "type": "boolean" }, "smsOptedOutAt": { "type": "string", "format": "date-time" }, "smsSendTimezone": { "type": "string" }, "smsLastDigestAt": { "type": "string", "format": "date-time" }, "notificationDigestFrequency": { "type": "string", "enum": [ "daily", "weekly" ] }, "emailLastDigestAt": { "type": "string", "format": "date-time" }, "image": { "type": "string", "nullable": true }, "userKind": { "type": "string" } }, "description": "{\"indexInfo\":{\"email\":{\"unique\":false},\"username\":{\"username\":{\"unique\":true}},\"userKind\":{\"userKind\":{\"unique\":false}}}}", "required": [ "email", "username" ], "additionalProperties": false }, "NewRoleGroupsInClearErcUser": { "title": "NewRoleGroupsInClearErcUser", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRoleGroupsInClearErcUser', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "owner": { "type": "number" }, "isPublic": { "type": "number" }, "isForCompany": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "NewCompanyInClearErcUser": { "title": "NewCompanyInClearErcUser", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCompanyInClearErcUser', exclude: [ 'id' ] })", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "expectedLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "goLiveDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "address": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "bankAddress": { "type": "string" }, "bankCity": { "type": "string" }, "bankState": { "type": "string" }, "bankZipCode": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "createdByUserId": { "type": "string" }, "ownedById": { "type": "string" }, "referredByCompanyId": { "type": "number" }, "tenantHost": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "reviewerId": { "type": "string" }, "website": { "type": "string" }, "logoUrl": { "type": "string" }, "logoStatus": { "type": "string", "nullable": true }, "logoCandidateUrl": { "type": "string", "nullable": true }, "logoCandidateDomain": { "type": "string", "nullable": true }, "logoSource": { "type": "string", "nullable": true }, "logoEvidence": { "type": "string", "nullable": true }, "logoReviewedByUserId": { "type": "string", "nullable": true }, "logoReviewedAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "statusUpdatedAt": { "type": "string", "format": "date-time" }, "employerPhaseOverride": { "type": "string" }, "trainingCommsSentAt": { "type": "string", "format": "date-time", "nullable": true }, "employeeInvitesProvisionedAt": { "type": "string", "format": "date-time", "nullable": true }, "employerIntroSentAt": { "type": "string", "format": "date-time", "nullable": true }, "defaultFolder": { "type": "number" }, "ranking": { "type": "number" }, "qualifiedLives": { "type": "number" }, "isATest": { "type": "number" }, "groupMaster": { "type": "number" }, "finalRefundAmount": { "type": "number" }, "totalFeePercent": { "type": "number", "nullable": true }, "totalFeeAmount": { "type": "number", "nullable": true }, "totalFeeType": { "type": "string" }, "upfrontFeePercent": { "type": "number", "nullable": true }, "upfrontFeeAmount": { "type": "number", "nullable": true }, "upfrontFeeType": { "type": "string" }, "upfrontFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "depositFeePercent": { "type": "number", "nullable": true }, "depositFeeAmount": { "type": "number", "nullable": true }, "depositFeeType": { "type": "string" }, "depositFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "laterFeePercent": { "type": "number", "nullable": true }, "laterFeeAmount": { "type": "number", "nullable": true }, "laterFeeType": { "type": "string" }, "laterFeeDate": { "type": "string", "format": "date-time", "nullable": true }, "hedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "group": { "type": "number", "nullable": true }, "feeHedgeFundBuyoutPrice": { "type": "number", "nullable": true }, "stripeCustomerId": { "type": "string" }, "qbCustomerId": { "type": "string" }, "routingNumber": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "accountHolderName": { "type": "string", "nullable": true }, "bankName": { "type": "string" }, "clientAddress": { "type": "string" }, "affiliateUserId": { "type": "string", "nullable": true }, "salesRepId": { "type": "string", "nullable": true }, "affiliateManagerId": { "type": "string", "nullable": true }, "payrollDataMethod": { "type": "string", "nullable": true }, "payrollDataStatus": { "type": "string", "nullable": true }, "payrollDataStatusNote": { "type": "string", "nullable": true }, "payrollDataStatusUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollDataStatusUpdatedById": { "type": "string", "nullable": true }, "payrollSubmissionCompleteAt": { "type": "string", "format": "date-time", "nullable": true }, "payrollSubmissionCompleteById": { "type": "string", "nullable": true }, "payrollProviderId": { "type": "string", "nullable": true }, "usesPeo": { "type": "boolean", "nullable": true }, "subAffiliateUserId": { "type": "string", "nullable": true }, "einNumber": { "type": "string" }, "businessEntityType": { "type": "string", "nullable": true }, "stateOfIncorporation": { "type": "string", "nullable": true }, "subSubAffiliateUserId": { "type": "string", "nullable": true }, "subSubSubAffiliateUserId": { "type": "string", "nullable": true }, "referrerUserId": { "type": "string", "nullable": true }, "language": { "type": "string" }, "companyType": { "type": "string" }, "livesCount": { "type": "number", "nullable": true }, "hedgeFundBuyoutCompanyId": { "type": "number" }, "feeHedgeFundBuyoutCompanyId": { "type": "number" }, "subAffiliateCommissionFee": { "type": "number", "nullable": true }, "affiliateCommissionTierOverrideId": { "type": "number", "nullable": true }, "charityCompanyId": { "type": "number", "nullable": true }, "processorCompanyId": { "type": "number", "nullable": true }, "affiliateHasBeenReviewed": { "type": "number", "nullable": true }, "affiliateWillPayDownlines": { "type": "number", "nullable": true }, "bypassContract": { "type": "number", "nullable": true }, "charityPayoutPerLife": { "type": "number" }, "isMarketingPartner": { "type": "boolean" }, "autoEnrollEmployees": { "type": "boolean" }, "calcomBookingUrl": { "type": "string" }, "affiliateCommissionSetValue": { "type": "number" }, "affiliateAmount": { "type": "number" }, "salesRepAmount": { "type": "number" }, "affiliateManagerAmount": { "type": "number" }, "subAffiliateAmount": { "type": "number" }, "subSubAffiliateAmount": { "type": "number" }, "subSubSubAffiliateAmount": { "type": "number" }, "grossWellnessFee": { "type": "number" }, "referrer1Id": { "type": "string", "nullable": true }, "referrer2Id": { "type": "string", "nullable": true }, "referrer3Id": { "type": "string", "nullable": true }, "referrer4Id": { "type": "string", "nullable": true }, "referrer5Id": { "type": "string", "nullable": true }, "referrer6Id": { "type": "string", "nullable": true }, "tariffsPaid": { "type": "string" }, "tariffsPaidToCountries": { "type": "string" }, "tariffIndustry": { "type": "string" }, "tariffEntryMethod": { "type": "string" }, "tariffComission1": { "type": "number" }, "tariffComission2": { "type": "number" }, "tariffComission1Sub": { "type": "number" }, "tariffComission2Sub": { "type": "number" }, "referrer1Amount": { "type": "number" }, "referrer2Amount": { "type": "number" }, "referrer3Amount": { "type": "number" }, "referrer4Amount": { "type": "number" }, "referrer5Amount": { "type": "number" }, "referrer6Amount": { "type": "number" }, "w2Employees": { "type": "number" }, "numberOfReferrers": { "type": "number" }, "enrolledW2Employees": { "type": "number" }, "estimatedTariffIncome": { "type": "number" }, "quotedTariffIncome": { "type": "number" }, "contractedTariffIncome": { "type": "number" }, "campaignFromEmail": { "type": "string" }, "campaignFromName": { "type": "string" }, "campaignReplyTo": { "type": "string" }, "dealState": { "type": "string", "nullable": true }, "dealLostReason": { "type": "string", "nullable": true }, "dealLostNote": { "type": "string", "nullable": true }, "dealLostAt": { "type": "string", "format": "date-time", "nullable": true }, "dealLostById": { "type": "string", "nullable": true }, "dealRevivedAt": { "type": "string", "format": "date-time", "nullable": true }, "dealRevivedById": { "type": "string", "nullable": true }, "dealTerminalRaisedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedAt": { "type": "string", "format": "date-time", "nullable": true }, "ladderNudgedById": { "type": "string", "nullable": true }, "employerGroupId": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "Cities": { "title": "Cities", "type": "object", "properties": { "id": { "type": "number" }, "city": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" } }, "required": [ "city", "county", "state" ], "additionalProperties": false }, "NewCities": { "title": "NewCities", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCities', exclude: [ 'id' ] })", "properties": { "city": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" } }, "required": [ "city", "county", "state" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CitiesWithRelations": { "title": "CitiesWithRelations", "type": "object", "description": "(tsType: CitiesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "city": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" } }, "required": [ "city", "county", "state" ], "additionalProperties": false, "x-typescript-type": "CitiesWithRelations" }, "CitiesPartial": { "title": "CitiesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "city": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Campaign": { "title": "Campaign", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "templateId": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "sending", "sent", "paused", "stopped" ] }, "subject": { "type": "string", "nullable": true }, "bodyHtml": { "type": "string", "nullable": true }, "salesMaterialIdsJson": { "type": "string", "nullable": true }, "calEventTypeKey": { "type": "string", "nullable": true }, "recipientFilterJson": { "type": "string", "nullable": true }, "throttlePerMinute": { "type": "number" }, "ownerJoinsMeetings": { "type": "boolean" }, "recipientCount": { "type": "number", "nullable": true }, "createdByUserId": { "type": "string", "nullable": true }, "launchedAt": { "type": "string", "format": "date-time", "nullable": true }, "sentAt": { "type": "string", "format": "date-time", "nullable": true }, "drainedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "idempotencyKey": { "type": "string" } }, "required": [ "companyId", "templateId", "name" ], "additionalProperties": false }, "CampaignStep": { "title": "CampaignStep", "type": "object", "properties": { "id": { "type": "number" }, "campaignId": { "type": "number" }, "stepOrder": { "type": "number" }, "delayDays": { "type": "number" }, "condition": { "type": "string" }, "templateId": { "type": "number" }, "subject": { "type": "string", "nullable": true }, "bodyHtml": { "type": "string", "nullable": true }, "salesMaterialIdsJson": { "type": "string", "nullable": true }, "calEventTypeKey": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "campaignId", "stepOrder", "delayDays", "condition", "templateId" ], "additionalProperties": false }, "CalEventType": { "title": "CalEventType", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "key": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "calComEventTypeId": { "type": "number", "nullable": true }, "linkVerdict": { "type": "string", "nullable": true }, "lastLinkStatus": { "type": "string", "nullable": true }, "lastLinkCheckAt": { "type": "string", "format": "date-time", "nullable": true }, "retiredAt": { "type": "string", "format": "date-time", "nullable": true } }, "description": "{\"indexInfo\":{\"key\":{\"unique\":true}}}", "required": [ "key", "name", "url" ], "additionalProperties": false }, "NewCalEventType": { "title": "NewCalEventType", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCalEventType', exclude: [ 'id' ] }), {\"indexInfo\":{\"key\":{\"unique\":true}}}", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "key": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "calComEventTypeId": { "type": "number", "nullable": true }, "linkVerdict": { "type": "string", "nullable": true }, "lastLinkStatus": { "type": "string", "nullable": true }, "lastLinkCheckAt": { "type": "string", "format": "date-time", "nullable": true }, "retiredAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "key", "name", "url" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CalEventTypeWithRelations": { "title": "CalEventTypeWithRelations", "type": "object", "description": "(tsType: CalEventTypeWithRelations, schemaOptions: { includeRelations: true }), {\"indexInfo\":{\"key\":{\"unique\":true}}}", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "key": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "calComEventTypeId": { "type": "number", "nullable": true }, "linkVerdict": { "type": "string", "nullable": true }, "lastLinkStatus": { "type": "string", "nullable": true }, "lastLinkCheckAt": { "type": "string", "format": "date-time", "nullable": true }, "retiredAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "key", "name", "url" ], "additionalProperties": false, "x-typescript-type": "CalEventTypeWithRelations" }, "CalEventTypePartial": { "title": "CalEventTypePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true }), {\"indexInfo\":{\"key\":{\"unique\":true}}}", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "key": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "calComEventTypeId": { "type": "number", "nullable": true }, "linkVerdict": { "type": "string", "nullable": true }, "lastLinkStatus": { "type": "string", "nullable": true }, "lastLinkCheckAt": { "type": "string", "format": "date-time", "nullable": true }, "retiredAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BusinessRulesPerGroup": { "title": "BusinessRulesPerGroup", "type": "object", "properties": { "businessRule": { "type": "number" }, "businessRuleGroup": { "type": "number" }, "id": { "type": "number" } }, "additionalProperties": false }, "NewBusinessRulesPerGroup": { "title": "NewBusinessRulesPerGroup", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBusinessRulesPerGroup', exclude: [ 'id' ] })", "properties": { "businessRule": { "type": "number" }, "businessRuleGroup": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BusinessRulesPerGroupWithRelations": { "title": "BusinessRulesPerGroupWithRelations", "type": "object", "description": "(tsType: BusinessRulesPerGroupWithRelations, schemaOptions: { includeRelations: true })", "properties": { "businessRule": { "type": "number" }, "businessRuleGroup": { "type": "number" }, "id": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "BusinessRulesPerGroupWithRelations" }, "BusinessRulesPerGroupPartial": { "title": "BusinessRulesPerGroupPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "businessRule": { "type": "number" }, "businessRuleGroup": { "type": "number" }, "id": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BusinessRule": { "title": "BusinessRule", "type": "object", "properties": { "id": { "type": "number" }, "ruleType": { "type": "number" }, "processflowId": { "type": "number" }, "fieldName": { "type": "string" }, "valueTriggerEnd": { "type": "string" }, "valueTriggerStart": { "type": "string" } }, "additionalProperties": false }, "NewBusinessRule": { "title": "NewBusinessRule", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBusinessRule', exclude: [ 'id' ] })", "properties": { "ruleType": { "type": "number" }, "processflowId": { "type": "number" }, "fieldName": { "type": "string" }, "valueTriggerEnd": { "type": "string" }, "valueTriggerStart": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BusinessRuleWithRelations": { "title": "BusinessRuleWithRelations", "type": "object", "description": "(tsType: BusinessRuleWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "ruleType": { "type": "number" }, "processflowId": { "type": "number" }, "fieldName": { "type": "string" }, "valueTriggerEnd": { "type": "string" }, "valueTriggerStart": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "BusinessRuleWithRelations" }, "BusinessRulePartial": { "title": "BusinessRulePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "ruleType": { "type": "number" }, "processflowId": { "type": "number" }, "fieldName": { "type": "string" }, "valueTriggerEnd": { "type": "string" }, "valueTriggerStart": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BusinessRuleType": { "title": "BusinessRuleType", "type": "object", "properties": { "comparisonType": { "type": "number" }, "usesField2": { "type": "number" }, "dataType": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "number" }, "matchValue": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "NewBusinessRuleType": { "title": "NewBusinessRuleType", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBusinessRuleType', exclude: [ 'id' ] })", "properties": { "comparisonType": { "type": "number" }, "usesField2": { "type": "number" }, "dataType": { "type": "string" }, "description": { "type": "string" }, "matchValue": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BusinessRuleTypeWithRelations": { "title": "BusinessRuleTypeWithRelations", "type": "object", "description": "(tsType: BusinessRuleTypeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "comparisonType": { "type": "number" }, "usesField2": { "type": "number" }, "dataType": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "number" }, "matchValue": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "BusinessRuleTypeWithRelations" }, "BusinessRuleTypePartial": { "title": "BusinessRuleTypePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "comparisonType": { "type": "number" }, "usesField2": { "type": "number" }, "dataType": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "number" }, "matchValue": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BusinessRuleGroupsPerProduct": { "title": "BusinessRuleGroupsPerProduct", "type": "object", "properties": { "businessProductId": { "type": "number" }, "businessRuleGroupId": { "type": "number" }, "id": { "type": "number" } }, "additionalProperties": false }, "NewBusinessRuleGroupsPerProduct": { "title": "NewBusinessRuleGroupsPerProduct", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBusinessRuleGroupsPerProduct', exclude: [ 'id' ] })", "properties": { "businessProductId": { "type": "number" }, "businessRuleGroupId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BusinessRuleGroupsPerProductWithRelations": { "title": "BusinessRuleGroupsPerProductWithRelations", "type": "object", "description": "(tsType: BusinessRuleGroupsPerProductWithRelations, schemaOptions: { includeRelations: true })", "properties": { "businessProductId": { "type": "number" }, "businessRuleGroupId": { "type": "number" }, "id": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "BusinessRuleGroupsPerProductWithRelations" }, "BusinessRuleGroupsPerProductPartial": { "title": "BusinessRuleGroupsPerProductPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "businessProductId": { "type": "number" }, "businessRuleGroupId": { "type": "number" }, "id": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewBusinessRuleGroup": { "title": "NewBusinessRuleGroup", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBusinessRuleGroup', exclude: [ 'id' ] })", "properties": { "description": { "type": "string" }, "isQualify": { "type": "number" }, "isAnd": { "type": "number" }, "product": { "type": "number" }, "folder": { "type": "number" }, "name": { "type": "string" } }, "required": [ "isQualify", "isAnd", "product" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BusinessRuleGroupWithRelations": { "title": "BusinessRuleGroupWithRelations", "type": "object", "description": "(tsType: BusinessRuleGroupWithRelations, schemaOptions: { includeRelations: true })", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "isQualify": { "type": "number" }, "isAnd": { "type": "number" }, "product": { "type": "number" }, "folder": { "type": "number" }, "name": { "type": "string" }, "businessRules": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRule" } }, "processflowStages": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessflowStages" } } }, "required": [ "isQualify", "isAnd", "product" ], "additionalProperties": false, "x-typescript-type": "BusinessRuleGroupWithRelations" }, "NewBusinessRuleInBusinessRuleGroup": { "title": "NewBusinessRuleInBusinessRuleGroup", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBusinessRuleInBusinessRuleGroup', exclude: [ 'id' ] })", "properties": { "ruleType": { "type": "number" }, "processflowId": { "type": "number" }, "fieldName": { "type": "string" }, "valueTriggerEnd": { "type": "string" }, "valueTriggerStart": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BusinessProduct": { "title": "BusinessProduct", "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" } }, "additionalProperties": false }, "NewBusinessProduct": { "title": "NewBusinessProduct", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBusinessProduct', exclude: [ 'id' ] })", "properties": { "description": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BusinessProductWithRelations": { "title": "BusinessProductWithRelations", "type": "object", "description": "(tsType: BusinessProductWithRelations, schemaOptions: { includeRelations: true })", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "businessRuleGroups": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRuleGroup" } } }, "additionalProperties": false, "x-typescript-type": "BusinessProductWithRelations" }, "BusinessProductPartial": { "title": "BusinessProductPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewBusinessRuleGroupInBusinessProduct": { "title": "NewBusinessRuleGroupInBusinessProduct", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBusinessRuleGroupInBusinessProduct', exclude: [ 'id' ] })", "properties": { "description": { "type": "string" }, "isQualify": { "type": "number" }, "isAnd": { "type": "number" }, "product": { "type": "number" }, "folder": { "type": "number" }, "name": { "type": "string" } }, "required": [ "isQualify", "isAnd", "product" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BulletPoints": { "title": "BulletPoints", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "bulletPointGroup": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewBulletPoints": { "title": "NewBulletPoints", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBulletPoints', exclude: [ 'id' ] })", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "bulletPointGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BulletPointsWithRelations": { "title": "BulletPointsWithRelations", "type": "object", "description": "(tsType: BulletPointsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "bulletPointGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "BulletPointsWithRelations" }, "BulletPointsPartial": { "title": "BulletPointsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "bulletPointGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BulletPointMandateGroup": { "title": "BulletPointMandateGroup", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "bulletPoint": { "type": "number", "nullable": true }, "mandateEffectGroup": { "type": "number", "nullable": true } }, "additionalProperties": false }, "NewBulletPointMandateGroup": { "title": "NewBulletPointMandateGroup", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBulletPointMandateGroup', exclude: [ 'id' ] })", "properties": { "bulletPoint": { "type": "number", "nullable": true }, "mandateEffectGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BulletPointMandateGroupWithRelations": { "title": "BulletPointMandateGroupWithRelations", "type": "object", "description": "(tsType: BulletPointMandateGroupWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "bulletPoint": { "type": "number", "nullable": true }, "mandateEffectGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "BulletPointMandateGroupWithRelations" }, "BulletPointMandateGroupPartial": { "title": "BulletPointMandateGroupPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "bulletPoint": { "type": "number", "nullable": true }, "mandateEffectGroup": { "type": "number", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BulletpointGroups": { "title": "BulletpointGroups", "type": "object", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewBulletpointGroups": { "title": "NewBulletpointGroups", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBulletpointGroups', exclude: [ 'id' ] })", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BulletpointGroupsWithRelations": { "title": "BulletpointGroupsWithRelations", "type": "object", "description": "(tsType: BulletpointGroupsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "BulletpointGroupsWithRelations" }, "BulletpointGroupsPartial": { "title": "BulletpointGroupsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number", "nullable": false }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BoardSection": { "title": "BoardSection", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "position": { "type": "number" }, "imageFilename": { "type": "string", "nullable": true }, "notesHtml": { "type": "string", "nullable": true }, "deleted": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name" ], "additionalProperties": false }, "BillingReconciliationRun": { "title": "BillingReconciliationRun", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "ok": { "type": "boolean" }, "mismatchCount": { "type": "number" }, "report": { "type": "object" } }, "required": [ "ok", "mismatchCount", "report" ], "additionalProperties": false }, "LedgerPosting": { "title": "LedgerPosting", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "entryGroupId": { "type": "string" }, "eventId": { "type": "string" }, "companyId": { "type": "number" }, "userId": { "type": "string" }, "account": { "type": "string", "enum": [ "receivable", "payable", "settlement" ] }, "direction": { "type": "string", "enum": [ "debit", "credit" ] }, "amount": { "type": "number" } }, "required": [ "entryGroupId", "eventId", "account", "direction", "amount" ], "additionalProperties": false }, "Appointments": { "title": "Appointments", "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "startsAt": { "type": "string", "format": "date-time", "nullable": true }, "endsAt": { "type": "string", "format": "date-time", "nullable": true }, "destinationCalendarEmail": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "bookingId": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "payload": { "type": "object", "nullable": true }, "triggerEvent": { "type": "string", "nullable": true }, "eventType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewAppointments": { "title": "NewAppointments", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewAppointments', exclude: [ 'id' ] })", "properties": { "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "startsAt": { "type": "string", "format": "date-time", "nullable": true }, "endsAt": { "type": "string", "format": "date-time", "nullable": true }, "destinationCalendarEmail": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "bookingId": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "payload": { "type": "object", "nullable": true }, "triggerEvent": { "type": "string", "nullable": true }, "eventType": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "AppointmentsWithRelations": { "title": "AppointmentsWithRelations", "type": "object", "description": "(tsType: AppointmentsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "startsAt": { "type": "string", "format": "date-time", "nullable": true }, "endsAt": { "type": "string", "format": "date-time", "nullable": true }, "destinationCalendarEmail": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "bookingId": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "payload": { "type": "object", "nullable": true }, "triggerEvent": { "type": "string", "nullable": true }, "eventType": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "AppointmentsWithRelations" }, "AppointmentsPartial": { "title": "AppointmentsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "startsAt": { "type": "string", "format": "date-time", "nullable": true }, "endsAt": { "type": "string", "format": "date-time", "nullable": true }, "destinationCalendarEmail": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": false }, "bookingId": { "type": "number", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "payload": { "type": "object", "nullable": true }, "triggerEvent": { "type": "string", "nullable": true }, "eventType": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "AppointmentDisposition": { "title": "AppointmentDisposition", "type": "object", "properties": { "id": { "type": "number" }, "bookingUid": { "type": "string" }, "prospectId": { "type": "number" }, "outcome": { "type": "string", "enum": [ "interested", "not_interested", "no_show", "follow_up" ] }, "dispositionedByUserId": { "type": "string", "nullable": true }, "dispositionedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "bookingUid", "prospectId", "outcome" ], "additionalProperties": false }, "Alert": { "title": "Alert", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertRuleId": { "type": "number" }, "userId": { "type": "string" }, "channel": { "type": "string" }, "channelId": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "link": { "type": "string" }, "dedupeKey": { "type": "string" }, "completedAt": { "type": "string", "format": "date-time" }, "actionLabel": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false }, "AlertWithRelations": { "title": "AlertWithRelations", "type": "object", "description": "(tsType: AlertWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertRuleId": { "type": "number" }, "userId": { "type": "string" }, "channel": { "type": "string" }, "channelId": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "link": { "type": "string" }, "dedupeKey": { "type": "string" }, "completedAt": { "type": "string", "format": "date-time" }, "actionLabel": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false, "x-typescript-type": "AlertWithRelations" }, "AlertPartial": { "title": "AlertPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertRuleId": { "type": "number" }, "userId": { "type": "string" }, "channel": { "type": "string" }, "channelId": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "link": { "type": "string" }, "dedupeKey": { "type": "string" }, "completedAt": { "type": "string", "format": "date-time" }, "actionLabel": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "AlertUserSettings": { "title": "AlertUserSettings", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string" }, "appEnabled": { "type": "boolean" }, "emailEnabled": { "type": "boolean" }, "smsEnabled": { "type": "boolean" }, "alertRuleId": { "type": "number" } }, "additionalProperties": false }, "NewAlertUserSettings": { "title": "NewAlertUserSettings", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, schemaOptions: { title: 'NewAlertUserSettings', optional: [ 'id' ] })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string" }, "appEnabled": { "type": "boolean" }, "emailEnabled": { "type": "boolean" }, "smsEnabled": { "type": "boolean" }, "alertRuleId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional" }, "AlertUserSettingsPartial": { "title": "AlertUserSettingsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string" }, "appEnabled": { "type": "boolean" }, "emailEnabled": { "type": "boolean" }, "smsEnabled": { "type": "boolean" }, "alertRuleId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "AlertType": { "title": "AlertType", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertType": { "type": "string" }, "interceptorDetails": { "type": "string" } }, "additionalProperties": false }, "NewAlertType": { "title": "NewAlertType", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, schemaOptions: { title: 'NewAlertType', optional: [ 'id' ] })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertType": { "type": "string" }, "interceptorDetails": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional" }, "AlertTypeWithRelations": { "title": "AlertTypeWithRelations", "type": "object", "description": "(tsType: AlertTypeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertType": { "type": "string" }, "interceptorDetails": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "AlertTypeWithRelations" }, "AlertRule": { "title": "AlertRule", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertTypeId": { "type": "number" }, "title": { "type": "string" }, "body": { "type": "string" }, "conditions": { "type": "object" }, "managed": { "type": "boolean" } }, "additionalProperties": false }, "NewAlertRule": { "title": "NewAlertRule", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, schemaOptions: { title: 'NewAlertRule', optional: [ 'id' ] })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertTypeId": { "type": "number" }, "title": { "type": "string" }, "body": { "type": "string" }, "conditions": { "type": "object" }, "managed": { "type": "boolean" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional" }, "AlertRuleWithRelations": { "title": "AlertRuleWithRelations", "type": "object", "description": "(tsType: AlertRuleWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertTypeId": { "type": "number" }, "title": { "type": "string" }, "body": { "type": "string" }, "conditions": { "type": "object" }, "managed": { "type": "boolean" } }, "additionalProperties": false, "x-typescript-type": "AlertRuleWithRelations" }, "AlertRuleChannel": { "title": "AlertRuleChannel", "type": "object", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertRuleId": { "type": "number" }, "channel": { "type": "string" }, "channelId": { "type": "string" }, "link": { "type": "string" }, "recipients": { "type": "string" } }, "additionalProperties": false }, "NewAlertRuleChannel": { "title": "NewAlertRuleChannel", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, schemaOptions: { title: 'NewAlertRuleChannel', optional: [ 'id' ] })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertRuleId": { "type": "number" }, "channel": { "type": "string" }, "channelId": { "type": "string" }, "link": { "type": "string" }, "recipients": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional" }, "AlertRuleChannelWithRelations": { "title": "AlertRuleChannelWithRelations", "type": "object", "description": "(tsType: AlertRuleChannelWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alertRuleId": { "type": "number" }, "channel": { "type": "string" }, "channelId": { "type": "string" }, "link": { "type": "string" }, "recipients": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "AlertRuleChannelWithRelations" }, "AlertCompanyMute": { "title": "AlertCompanyMute", "type": "object", "properties": { "id": { "type": "number" }, "companyId": { "type": "number" }, "alertTypeId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "companyId", "alertTypeId" ], "additionalProperties": false }, "AffiliateContract": { "title": "AffiliateContract", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string" }, "clearErcUserId": { "type": "string" }, "userSignedContractAt": { "type": "string", "format": "date-time" }, "affiliateContractTemplateId": { "type": "number" }, "userEmailedSignedContractAt": { "type": "string", "format": "date-time" }, "clearErcUserEmailedSignedContractAt": { "type": "string", "format": "date-time" }, "contract": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "NewAffiliateContract": { "title": "NewAffiliateContract", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, schemaOptions: { title: 'NewAffiliateContract', optional: [ 'id' ] })", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string" }, "clearErcUserId": { "type": "string" }, "userSignedContractAt": { "type": "string", "format": "date-time" }, "affiliateContractTemplateId": { "type": "number" }, "userEmailedSignedContractAt": { "type": "string", "format": "date-time" }, "clearErcUserEmailedSignedContractAt": { "type": "string", "format": "date-time" }, "contract": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional" }, "AffiliateContractWithRelations": { "title": "AffiliateContractWithRelations", "type": "object", "description": "(tsType: AffiliateContractWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string" }, "clearErcUserId": { "type": "string" }, "userSignedContractAt": { "type": "string", "format": "date-time" }, "affiliateContractTemplateId": { "type": "number" }, "userEmailedSignedContractAt": { "type": "string", "format": "date-time" }, "clearErcUserEmailedSignedContractAt": { "type": "string", "format": "date-time" }, "contract": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false, "x-typescript-type": "AffiliateContractWithRelations" }, "AffiliateContractPartial": { "title": "AffiliateContractPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string" }, "clearErcUserId": { "type": "string" }, "userSignedContractAt": { "type": "string", "format": "date-time" }, "affiliateContractTemplateId": { "type": "number" }, "userEmailedSignedContractAt": { "type": "string", "format": "date-time" }, "clearErcUserEmailedSignedContractAt": { "type": "string", "format": "date-time" }, "contract": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "AffiliateContract.Filter": { "type": "object", "title": "AffiliateContract.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "userId": { "type": "boolean" }, "clearErcUserId": { "type": "boolean" }, "userSignedContractAt": { "type": "boolean" }, "affiliateContractTemplateId": { "type": "boolean" }, "userEmailedSignedContractAt": { "type": "boolean" }, "clearErcUserEmailedSignedContractAt": { "type": "boolean" }, "contract": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "userId", "clearErcUserId", "userSignedContractAt", "affiliateContractTemplateId", "userEmailedSignedContractAt", "clearErcUserEmailedSignedContractAt", "contract" ], "example": "id" }, "uniqueItems": true } ], "title": "AffiliateContract.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "AffiliateContract.Filter1": { "type": "object", "title": "AffiliateContract.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "AffiliateContract.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "userId": { "type": "boolean" }, "clearErcUserId": { "type": "boolean" }, "userSignedContractAt": { "type": "boolean" }, "affiliateContractTemplateId": { "type": "boolean" }, "userEmailedSignedContractAt": { "type": "boolean" }, "clearErcUserEmailedSignedContractAt": { "type": "boolean" }, "contract": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "userId", "clearErcUserId", "userSignedContractAt", "affiliateContractTemplateId", "userEmailedSignedContractAt", "clearErcUserEmailedSignedContractAt", "contract" ], "example": "id" }, "uniqueItems": true } ], "title": "AffiliateContract.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CommitAffiliateImport": { "type": "object", "required": [ "companyId", "mapping", "mode" ], "properties": { "companyId": { "type": "number" }, "fileName": { "type": "string" }, "contentBase64": { "type": "string" }, "parseToken": { "type": "string" }, "mapping": { "type": "object" }, "mode": { "type": "string", "enum": [ "sub_affiliate", "referred" ] }, "defaultCommissionRate": { "type": "number", "nullable": true } }, "title": "CommitAffiliateImport" }, "ParseAffiliateImport": { "type": "object", "required": [ "companyId", "fileName", "contentBase64" ], "properties": { "companyId": { "type": "number" }, "fileName": { "type": "string" }, "contentBase64": { "type": "string" } }, "title": "ParseAffiliateImport" }, "AlertRuleChannel.Filter": { "type": "object", "title": "AlertRuleChannel.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "alertRuleId": { "type": "boolean" }, "channel": { "type": "boolean" }, "channelId": { "type": "boolean" }, "link": { "type": "boolean" }, "recipients": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "alertRuleId", "channel", "channelId", "link", "recipients" ], "example": "id" }, "uniqueItems": true } ], "title": "AlertRuleChannel.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "AlertRuleChannel.Filter1": { "type": "object", "title": "AlertRuleChannel.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "AlertRuleChannel.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "alertRuleId": { "type": "boolean" }, "channel": { "type": "boolean" }, "channelId": { "type": "boolean" }, "link": { "type": "boolean" }, "recipients": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "alertRuleId", "channel", "channelId", "link", "recipients" ], "example": "id" }, "uniqueItems": true } ], "title": "AlertRuleChannel.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "AlertRule.Filter": { "type": "object", "title": "AlertRule.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "alertTypeId": { "type": "boolean" }, "title": { "type": "boolean" }, "body": { "type": "boolean" }, "conditions": { "type": "boolean" }, "managed": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "alertTypeId", "title", "body", "conditions", "managed" ], "example": "id" }, "uniqueItems": true } ], "title": "AlertRule.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "AlertRule.Filter1": { "type": "object", "title": "AlertRule.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "AlertRule.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "alertTypeId": { "type": "boolean" }, "title": { "type": "boolean" }, "body": { "type": "boolean" }, "conditions": { "type": "boolean" }, "managed": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "alertTypeId", "title", "body", "conditions", "managed" ], "example": "id" }, "uniqueItems": true } ], "title": "AlertRule.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "AlertType.Filter": { "type": "object", "title": "AlertType.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "alertType": { "type": "boolean" }, "interceptorDetails": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "alertType", "interceptorDetails" ], "example": "id" }, "uniqueItems": true } ], "title": "AlertType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "AlertType.Filter1": { "type": "object", "title": "AlertType.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "AlertType.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "alertType": { "type": "boolean" }, "interceptorDetails": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "alertType", "interceptorDetails" ], "example": "id" }, "uniqueItems": true } ], "title": "AlertType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "AlertUserSettingsWithRelations": { "title": "AlertUserSettingsWithRelations", "type": "object", "description": "(tsType: AlertUserSettingsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string" }, "appEnabled": { "type": "boolean" }, "emailEnabled": { "type": "boolean" }, "smsEnabled": { "type": "boolean" }, "alertRuleId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "AlertUserSettingsWithRelations" }, "AlertUserSettings.Filter": { "type": "object", "title": "AlertUserSettings.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "AlertUserSettings.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "userId": { "type": "boolean" }, "appEnabled": { "type": "boolean" }, "emailEnabled": { "type": "boolean" }, "smsEnabled": { "type": "boolean" }, "alertRuleId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "userId", "appEnabled", "emailEnabled", "smsEnabled", "alertRuleId" ], "example": "id" }, "uniqueItems": true } ], "title": "AlertUserSettings.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "NewAlert": { "properties": { "id": { "type": "number" }, "link": { "type": "string" }, "channel": { "type": "string" }, "alertRuleId": { "type": "number" }, "channelId": { "type": "string" }, "userId": { "type": "string" }, "roleGroupId": { "type": "number" }, "body": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "string" }, "actionLabel": { "type": "string" } }, "title": "NewAlert" }, "Alert.Filter": { "type": "object", "title": "Alert.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Alert.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "alertRuleId": { "type": "boolean" }, "userId": { "type": "boolean" }, "channel": { "type": "boolean" }, "channelId": { "type": "boolean" }, "status": { "type": "boolean" }, "title": { "type": "boolean" }, "body": { "type": "boolean" }, "link": { "type": "boolean" }, "dedupeKey": { "type": "boolean" }, "completedAt": { "type": "boolean" }, "actionLabel": { "type": "boolean" }, "actions": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "alertRuleId", "userId", "channel", "channelId", "status", "title", "body", "link", "dedupeKey", "completedAt", "actionLabel", "actions" ], "example": "id" }, "uniqueItems": true } ], "title": "Alert.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "AppointmentDisposition.Filter": { "type": "object", "title": "AppointmentDisposition.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "AppointmentDisposition.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "bookingUid": { "type": "boolean" }, "prospectId": { "type": "boolean" }, "outcome": { "type": "boolean" }, "dispositionedByUserId": { "type": "boolean" }, "dispositionedAt": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "bookingUid", "prospectId", "outcome", "dispositionedByUserId", "dispositionedAt", "createdAt", "updatedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "AppointmentDisposition.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "loopback.Count": { "type": "object", "title": "loopback.Count", "x-typescript-type": "@loopback/repository#Count", "properties": { "count": { "type": "number" } } }, "Appointments.Filter": { "type": "object", "title": "Appointments.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "createdAt": { "type": "boolean" }, "startsAt": { "type": "boolean" }, "endsAt": { "type": "boolean" }, "destinationCalendarEmail": { "type": "boolean" }, "email": { "type": "boolean" }, "id": { "type": "boolean" }, "bookingId": { "type": "boolean" }, "companyId": { "type": "boolean" }, "payload": { "type": "boolean" }, "triggerEvent": { "type": "boolean" }, "eventType": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "createdAt", "startsAt", "endsAt", "destinationCalendarEmail", "email", "id", "bookingId", "companyId", "payload", "triggerEvent", "eventType" ], "example": "createdAt" }, "uniqueItems": true } ], "title": "Appointments.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Appointments.Filter1": { "type": "object", "title": "Appointments.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Appointments.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "createdAt": { "type": "boolean" }, "startsAt": { "type": "boolean" }, "endsAt": { "type": "boolean" }, "destinationCalendarEmail": { "type": "boolean" }, "email": { "type": "boolean" }, "id": { "type": "boolean" }, "bookingId": { "type": "boolean" }, "companyId": { "type": "boolean" }, "payload": { "type": "boolean" }, "triggerEvent": { "type": "boolean" }, "eventType": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "createdAt", "startsAt", "endsAt", "destinationCalendarEmail", "email", "id", "bookingId", "companyId", "payload", "triggerEvent", "eventType" ], "example": "createdAt" }, "uniqueItems": true } ], "title": "Appointments.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BoardProjectReorder": { "type": "object", "required": [ "sectionId", "orderedIds" ], "properties": { "sectionId": { "type": "number" }, "orderedIds": { "type": "array", "items": { "type": "number" } } }, "title": "BoardProjectReorder" }, "BoardProjectUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "sectionId": { "type": "number" }, "archived": { "type": "boolean" }, "imageFilename": { "type": "string", "nullable": true } }, "title": "BoardProjectUpdate" }, "BoardProjectCreate": { "type": "object", "required": [ "name", "sectionId" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "sectionId": { "type": "number" } }, "title": "BoardProjectCreate" }, "BoardSectionReorder": { "type": "object", "required": [ "orderedIds" ], "properties": { "orderedIds": { "type": "array", "items": { "type": "number" } } }, "title": "BoardSectionReorder" }, "BoardSectionGrantsReplace": { "type": "object", "required": [ "userIds", "roleGroupIds" ], "properties": { "userIds": { "type": "array", "items": { "type": "string" } }, "roleGroupIds": { "type": "array", "items": { "type": "number" } } }, "title": "BoardSectionGrantsReplace" }, "BoardSectionUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "imageFilename": { "type": "string", "nullable": true }, "notesHtml": { "type": "string", "nullable": true } }, "title": "BoardSectionUpdate" }, "BoardSectionCreate": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "title": "BoardSectionCreate" }, "NewBoardServiceToken": { "type": "object", "required": [ "label", "userId" ], "properties": { "label": { "type": "string" }, "userId": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } }, "title": "NewBoardServiceToken" }, "NewBoardTaskAttachment": { "type": "object", "required": [ "filename" ], "properties": { "filename": { "type": "string" }, "originalFilename": { "type": "string" }, "mimetype": { "type": "string" }, "encoding": { "type": "string" }, "size": { "type": "number" } }, "title": "NewBoardTaskAttachment" }, "BoardTaskClaim": { "type": "object", "properties": { "claimant": { "type": "string", "enum": [ "claude" ] } }, "title": "BoardTaskClaim" }, "BoardTaskCommentPatch": { "type": "object", "required": [ "bodyHtml" ], "properties": { "bodyHtml": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" } }, "title": "BoardTaskCommentPatch" }, "NewBoardTaskComment": { "type": "object", "required": [ "bodyHtml" ], "properties": { "bodyHtml": { "type": "string" } }, "title": "NewBoardTaskComment" }, "BoardTaskMove": { "type": "object", "required": [ "projectId" ], "properties": { "projectId": { "type": "number" } }, "title": "BoardTaskMove" }, "BoardTaskPause": { "type": "object", "required": [ "paused" ], "properties": { "paused": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } }, "title": "BoardTaskPause" }, "BoardTaskQuestionAnswer": { "type": "object", "required": [ "answerText" ], "properties": { "answerText": { "type": "string" } }, "title": "BoardTaskQuestionAnswer" }, "BoardTaskQuestionPatch": { "type": "object", "properties": { "prompt": { "type": "string" }, "kind": { "type": "string", "enum": [ "freeform", "select", "multiselect" ] }, "options": { "type": "array", "items": { "type": "string" } } }, "title": "BoardTaskQuestionPatch" }, "NewBoardTaskQuestion": { "type": "object", "required": [ "prompt", "kind" ], "properties": { "prompt": { "type": "string" }, "kind": { "type": "string", "enum": [ "freeform", "select", "multiselect" ] }, "options": { "type": "array", "items": { "type": "string" } } }, "title": "NewBoardTaskQuestion" }, "NewBoardTaskRelation": { "type": "object", "required": [ "toTaskId", "kind" ], "properties": { "toTaskId": { "type": "number" }, "kind": { "type": "string", "enum": [ "blocked_by", "relates_to" ] } }, "title": "NewBoardTaskRelation" }, "BoardTaskPatch": { "type": "object", "properties": { "title": { "type": "string" }, "descriptionHtml": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "todo", "in_progress", "blocked", "done" ] }, "assigneeUserId": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "nullable": true }, "topicId": { "type": "number", "nullable": true }, "parentTaskId": { "type": "number", "nullable": true }, "requiredToResolve": { "type": "string", "nullable": true }, "requiredToResolveItems": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "done": { "type": "boolean" } } } }, "allowUnmetRequirements": { "type": "boolean" } }, "title": "BoardTaskPatch" }, "NewBoardTask": { "type": "object", "required": [ "projectId", "title" ], "properties": { "projectId": { "type": "number" }, "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "topicId": { "type": "number" }, "parentTaskId": { "type": "number" }, "status": { "type": "string", "enum": [ "todo", "in_progress", "blocked", "done" ] }, "assigneeUserId": { "type": "string" }, "dueDate": { "type": "string" }, "requiredToResolve": { "type": "string" }, "requiredToResolveItems": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "done": { "type": "boolean" } } } } }, "title": "NewBoardTask" }, "BoardTopicReorder": { "type": "object", "required": [ "projectId", "orderedIds" ], "properties": { "projectId": { "type": "number" }, "orderedIds": { "type": "array", "items": { "type": "number" } } }, "title": "BoardTopicReorder" }, "BoardTopicUpdate": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "title": "BoardTopicUpdate" }, "BoardTopicCreate": { "type": "object", "required": [ "projectId", "name" ], "properties": { "projectId": { "type": "number" }, "name": { "type": "string" } }, "title": "BoardTopicCreate" }, "BulletPointMandateGroup.Filter": { "type": "object", "title": "BulletPointMandateGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "bulletPoint": { "type": "boolean" }, "mandateEffectGroup": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "bulletPoint", "mandateEffectGroup" ], "example": "id" }, "uniqueItems": true } ], "title": "BulletPointMandateGroup.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BulletPointMandateGroup.Filter1": { "type": "object", "title": "BulletPointMandateGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BulletPointMandateGroup.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "bulletPoint": { "type": "boolean" }, "mandateEffectGroup": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "bulletPoint", "mandateEffectGroup" ], "example": "id" }, "uniqueItems": true } ], "title": "BulletPointMandateGroup.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BulletPoints.Filter": { "type": "object", "title": "BulletPoints.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "bulletPointGroup": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description", "bulletPointGroup" ], "example": "id" }, "uniqueItems": true } ], "title": "BulletPoints.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BulletPoints.Filter1": { "type": "object", "title": "BulletPoints.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BulletPoints.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "bulletPointGroup": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description", "bulletPointGroup" ], "example": "id" }, "uniqueItems": true } ], "title": "BulletPoints.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BulletpointGroups.Filter": { "type": "object", "title": "BulletpointGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name" ], "example": "id" }, "uniqueItems": true } ], "title": "BulletpointGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BulletpointGroups.Filter1": { "type": "object", "title": "BulletpointGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BulletpointGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name" ], "example": "id" }, "uniqueItems": true } ], "title": "BulletpointGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessProduct.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "BusinessProduct.ScopeFilter" }, "BusinessProduct.IncludeFilter.Items": { "title": "BusinessProduct.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "businessRuleGroups" ] }, "scope": { "$ref": "#/components/schemas/BusinessProduct.ScopeFilter" } } }, "BusinessProduct.Filter": { "type": "object", "title": "BusinessProduct.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "name" ], "example": "description" }, "uniqueItems": true } ], "title": "BusinessProduct.Fields" }, "include": { "title": "BusinessProduct.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BusinessProduct.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessProduct.Filter1": { "type": "object", "title": "BusinessProduct.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BusinessProduct.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "name" ], "example": "description" }, "uniqueItems": true } ], "title": "BusinessProduct.Fields" }, "include": { "title": "BusinessProduct.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BusinessProduct.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessRuleGroup.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "BusinessRuleGroup.ScopeFilter" }, "BusinessRuleGroup.IncludeFilter.Items": { "title": "BusinessRuleGroup.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "businessRules", "processflowStages" ] }, "scope": { "$ref": "#/components/schemas/BusinessRuleGroup.ScopeFilter" } } }, "BusinessRuleGroup.Filter": { "type": "object", "title": "BusinessRuleGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "isQualify": { "type": "boolean" }, "isAnd": { "type": "boolean" }, "product": { "type": "boolean" }, "folder": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "isQualify", "isAnd", "product", "folder", "name" ], "example": "description" }, "uniqueItems": true } ], "title": "BusinessRuleGroup.Fields" }, "include": { "title": "BusinessRuleGroup.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BusinessRuleGroup.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessRuleGroup.Filter1": { "type": "object", "title": "BusinessRuleGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BusinessRuleGroup.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "isQualify": { "type": "boolean" }, "isAnd": { "type": "boolean" }, "product": { "type": "boolean" }, "folder": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "isQualify", "isAnd", "product", "folder", "name" ], "example": "description" }, "uniqueItems": true } ], "title": "BusinessRuleGroup.Fields" }, "include": { "title": "BusinessRuleGroup.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BusinessRuleGroup.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessRuleGroupsPerProduct.Filter": { "type": "object", "title": "BusinessRuleGroupsPerProduct.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "businessProductId": { "type": "boolean" }, "businessRuleGroupId": { "type": "boolean" }, "id": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "businessProductId", "businessRuleGroupId", "id" ], "example": "businessProductId" }, "uniqueItems": true } ], "title": "BusinessRuleGroupsPerProduct.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessRuleGroupsPerProduct.Filter1": { "type": "object", "title": "BusinessRuleGroupsPerProduct.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BusinessRuleGroupsPerProduct.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "businessProductId": { "type": "boolean" }, "businessRuleGroupId": { "type": "boolean" }, "id": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "businessProductId", "businessRuleGroupId", "id" ], "example": "businessProductId" }, "uniqueItems": true } ], "title": "BusinessRuleGroupsPerProduct.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessRuleType.Filter": { "type": "object", "title": "BusinessRuleType.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "comparisonType": { "type": "boolean" }, "usesField2": { "type": "boolean" }, "dataType": { "type": "boolean" }, "description": { "type": "boolean" }, "id": { "type": "boolean" }, "matchValue": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "comparisonType", "usesField2", "dataType", "description", "id", "matchValue", "name" ], "example": "comparisonType" }, "uniqueItems": true } ], "title": "BusinessRuleType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessRuleType.Filter1": { "type": "object", "title": "BusinessRuleType.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BusinessRuleType.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "comparisonType": { "type": "boolean" }, "usesField2": { "type": "boolean" }, "dataType": { "type": "boolean" }, "description": { "type": "boolean" }, "id": { "type": "boolean" }, "matchValue": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "comparisonType", "usesField2", "dataType", "description", "id", "matchValue", "name" ], "example": "comparisonType" }, "uniqueItems": true } ], "title": "BusinessRuleType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessRule.Filter": { "type": "object", "title": "BusinessRule.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "ruleType": { "type": "boolean" }, "processflowId": { "type": "boolean" }, "fieldName": { "type": "boolean" }, "valueTriggerEnd": { "type": "boolean" }, "valueTriggerStart": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "ruleType", "processflowId", "fieldName", "valueTriggerEnd", "valueTriggerStart" ], "example": "id" }, "uniqueItems": true } ], "title": "BusinessRule.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessRule.Filter1": { "type": "object", "title": "BusinessRule.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BusinessRule.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "ruleType": { "type": "boolean" }, "processflowId": { "type": "boolean" }, "fieldName": { "type": "boolean" }, "valueTriggerEnd": { "type": "boolean" }, "valueTriggerStart": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "ruleType", "processflowId", "fieldName", "valueTriggerEnd", "valueTriggerStart" ], "example": "id" }, "uniqueItems": true } ], "title": "BusinessRule.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessRulesPerGroup.Filter": { "type": "object", "title": "BusinessRulesPerGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "businessRule": { "type": "boolean" }, "businessRuleGroup": { "type": "boolean" }, "id": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "businessRule", "businessRuleGroup", "id" ], "example": "businessRule" }, "uniqueItems": true } ], "title": "BusinessRulesPerGroup.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BusinessRulesPerGroup.Filter1": { "type": "object", "title": "BusinessRulesPerGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BusinessRulesPerGroup.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "businessRule": { "type": "boolean" }, "businessRuleGroup": { "type": "boolean" }, "id": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "businessRule", "businessRuleGroup", "id" ], "example": "businessRule" }, "uniqueItems": true } ], "title": "BusinessRulesPerGroup.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CalEventType.Filter": { "type": "object", "title": "CalEventType.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "key": { "type": "boolean" }, "name": { "type": "boolean" }, "url": { "type": "boolean" }, "calComEventTypeId": { "type": "boolean" }, "linkVerdict": { "type": "boolean" }, "lastLinkStatus": { "type": "boolean" }, "lastLinkCheckAt": { "type": "boolean" }, "retiredAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "key", "name", "url", "calComEventTypeId", "linkVerdict", "lastLinkStatus", "lastLinkCheckAt", "retiredAt" ], "example": "id" }, "uniqueItems": true } ], "title": "CalEventType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CalEventType.Filter1": { "type": "object", "title": "CalEventType.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CalEventType.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "key": { "type": "boolean" }, "name": { "type": "boolean" }, "url": { "type": "boolean" }, "calComEventTypeId": { "type": "boolean" }, "linkVerdict": { "type": "boolean" }, "lastLinkStatus": { "type": "boolean" }, "lastLinkCheckAt": { "type": "boolean" }, "retiredAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "key", "name", "url", "calComEventTypeId", "linkVerdict", "lastLinkStatus", "lastLinkCheckAt", "retiredAt" ], "example": "id" }, "uniqueItems": true } ], "title": "CalEventType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PreviewCampaign": { "type": "object", "required": [ "companyId", "templateId" ], "properties": { "companyId": { "type": "number" }, "templateId": { "type": "number" }, "prospectId": { "type": "number" } }, "title": "PreviewCampaign" }, "TestSendCampaign": { "type": "object", "required": [ "companyId", "templateId" ], "properties": { "companyId": { "type": "number" }, "templateId": { "type": "number" }, "prospectId": { "type": "number" }, "to": { "type": "string", "format": "email" } }, "title": "TestSendCampaign" }, "UpdateCampaignStep": { "type": "object", "properties": { "delayDays": { "type": "number" }, "condition": { "type": "string", "enum": [ "not_opened", "not_clicked", "not_replied", "not_booked", "bounced" ] }, "templateId": { "type": "number" } }, "title": "UpdateCampaignStep" }, "CreateCampaignStep": { "type": "object", "required": [ "delayDays", "condition", "templateId" ], "properties": { "delayDays": { "type": "number" }, "condition": { "type": "string", "enum": [ "not_opened", "not_clicked", "not_replied", "not_booked", "bounced" ] }, "templateId": { "type": "number" } }, "title": "CreateCampaignStep" }, "UpdateCampaignDraft": { "type": "object", "properties": { "name": { "type": "string" }, "templateId": { "type": "number" }, "recipientFilter": { "type": "object", "properties": { "status": { "type": "string" }, "search": { "type": "string" }, "excludedProspectIds": { "type": "array", "items": { "type": "number" } } } }, "throttlePerMinute": { "type": "number" }, "ownerJoinsMeetings": { "type": "boolean" } }, "title": "UpdateCampaignDraft" }, "CreateCampaign": { "type": "object", "required": [ "companyId", "templateId", "name" ], "properties": { "companyId": { "type": "number" }, "templateId": { "type": "number" }, "name": { "type": "string" }, "recipientFilter": { "type": "object", "properties": { "status": { "type": "string" }, "search": { "type": "string" }, "excludedProspectIds": { "type": "array", "items": { "type": "number" } } } }, "throttlePerMinute": { "type": "number" }, "ownerJoinsMeetings": { "type": "boolean" }, "idempotencyKey": { "type": "string", "maxLength": 64 } }, "title": "CreateCampaign" }, "Campaign.Filter": { "type": "object", "title": "Campaign.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Campaign.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "templateId": { "type": "boolean" }, "name": { "type": "boolean" }, "status": { "type": "boolean" }, "subject": { "type": "boolean" }, "bodyHtml": { "type": "boolean" }, "salesMaterialIdsJson": { "type": "boolean" }, "calEventTypeKey": { "type": "boolean" }, "recipientFilterJson": { "type": "boolean" }, "throttlePerMinute": { "type": "boolean" }, "ownerJoinsMeetings": { "type": "boolean" }, "recipientCount": { "type": "boolean" }, "createdByUserId": { "type": "boolean" }, "launchedAt": { "type": "boolean" }, "sentAt": { "type": "boolean" }, "drainedAt": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "idempotencyKey": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "templateId", "name", "status", "subject", "bodyHtml", "salesMaterialIdsJson", "calEventTypeKey", "recipientFilterJson", "throttlePerMinute", "ownerJoinsMeetings", "recipientCount", "createdByUserId", "launchedAt", "sentAt", "drainedAt", "createdAt", "updatedAt", "idempotencyKey" ], "example": "id" }, "uniqueItems": true } ], "title": "Campaign.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Cities.Filter": { "type": "object", "title": "Cities.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "city": { "type": "boolean" }, "county": { "type": "boolean" }, "state": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "city", "county", "state" ], "example": "id" }, "uniqueItems": true } ], "title": "Cities.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Cities.Filter1": { "type": "object", "title": "Cities.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Cities.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "city": { "type": "boolean" }, "county": { "type": "boolean" }, "state": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "city", "county", "state" ], "example": "id" }, "uniqueItems": true } ], "title": "Cities.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ClientStatuses.Filter": { "type": "object", "title": "ClientStatuses.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "requiredRoles": { "type": "boolean" }, "mondayId": { "type": "boolean" }, "order": { "type": "boolean" }, "level": { "type": "boolean" }, "parent": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description", "requiredRoles", "mondayId", "order", "level", "parent" ], "example": "id" }, "uniqueItems": true } ], "title": "ClientStatuses.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ClientStatuses.Filter1": { "type": "object", "title": "ClientStatuses.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ClientStatuses.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "requiredRoles": { "type": "boolean" }, "mondayId": { "type": "boolean" }, "order": { "type": "boolean" }, "level": { "type": "boolean" }, "parent": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description", "requiredRoles", "mondayId", "order", "level", "parent" ], "example": "id" }, "uniqueItems": true } ], "title": "ClientStatuses.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ClosureLikelihoodEntries.Filter": { "type": "object", "title": "ClosureLikelihoodEntries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "companyId": { "type": "boolean" }, "dateUpdated": { "type": "boolean" }, "id": { "type": "boolean" }, "likelihoodTypeId": { "type": "boolean" }, "userIdUpdatedBy": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "companyId", "dateUpdated", "id", "likelihoodTypeId", "userIdUpdatedBy" ], "example": "companyId" }, "uniqueItems": true } ], "title": "ClosureLikelihoodEntries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ClosureLikelihoodEntries.Filter1": { "type": "object", "title": "ClosureLikelihoodEntries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ClosureLikelihoodEntries.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "companyId": { "type": "boolean" }, "dateUpdated": { "type": "boolean" }, "id": { "type": "boolean" }, "likelihoodTypeId": { "type": "boolean" }, "userIdUpdatedBy": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "companyId", "dateUpdated", "id", "likelihoodTypeId", "userIdUpdatedBy" ], "example": "companyId" }, "uniqueItems": true } ], "title": "ClosureLikelihoodEntries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ClosureLikelihoodTypes.Filter": { "type": "object", "title": "ClosureLikelihoodTypes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "percentage": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "percentage" ], "example": "id" }, "uniqueItems": true } ], "title": "ClosureLikelihoodTypes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ClosureLikelihoodTypes.Filter1": { "type": "object", "title": "ClosureLikelihoodTypes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ClosureLikelihoodTypes.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "percentage": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "percentage" ], "example": "id" }, "uniqueItems": true } ], "title": "ClosureLikelihoodTypes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CommissionChange.Filter": { "type": "object", "title": "CommissionChange.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "previousAmount": { "type": "boolean" }, "companyId": { "type": "boolean" }, "changedBy": { "type": "boolean" }, "changeType": { "type": "boolean" }, "newAmount": { "type": "boolean" }, "dateChanged": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "previousAmount", "companyId", "changedBy", "changeType", "newAmount", "dateChanged" ], "example": "id" }, "uniqueItems": true } ], "title": "CommissionChange.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CommissionChange.Filter1": { "type": "object", "title": "CommissionChange.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CommissionChange.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "previousAmount": { "type": "boolean" }, "companyId": { "type": "boolean" }, "changedBy": { "type": "boolean" }, "changeType": { "type": "boolean" }, "newAmount": { "type": "boolean" }, "dateChanged": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "previousAmount", "companyId", "changedBy", "changeType", "newAmount", "dateChanged" ], "example": "id" }, "uniqueItems": true } ], "title": "CommissionChange.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Company.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Company.ScopeFilter" }, "Company.IncludeFilter.Items": { "title": "Company.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "createdByUser", "ownedBy", "reviewedBy", "hedgeFundBuyoutCompany", "feeHedgeFundBuyoutCompany", "clearErcUsers", "userCompanies" ] }, "scope": { "$ref": "#/components/schemas/Company.ScopeFilter" } } }, "Company.Filter": { "type": "object", "title": "Company.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "expectedLiveDate": { "type": "boolean" }, "goLiveDate": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "address": { "type": "boolean" }, "city": { "type": "boolean" }, "zipCode": { "type": "boolean" }, "bankAddress": { "type": "boolean" }, "bankCity": { "type": "boolean" }, "bankState": { "type": "boolean" }, "bankZipCode": { "type": "boolean" }, "country": { "type": "boolean" }, "email": { "type": "boolean" }, "createdByUserId": { "type": "boolean" }, "ownedById": { "type": "boolean" }, "referredByCompanyId": { "type": "boolean" }, "tenantHost": { "type": "boolean" }, "name": { "type": "boolean" }, "phone": { "type": "boolean" }, "state": { "type": "boolean" }, "reviewerId": { "type": "boolean" }, "website": { "type": "boolean" }, "logoUrl": { "type": "boolean" }, "logoStatus": { "type": "boolean" }, "logoCandidateUrl": { "type": "boolean" }, "logoCandidateDomain": { "type": "boolean" }, "logoSource": { "type": "boolean" }, "logoEvidence": { "type": "boolean" }, "logoReviewedByUserId": { "type": "boolean" }, "logoReviewedAt": { "type": "boolean" }, "status": { "type": "boolean" }, "statusUpdatedAt": { "type": "boolean" }, "employerPhaseOverride": { "type": "boolean" }, "trainingCommsSentAt": { "type": "boolean" }, "employeeInvitesProvisionedAt": { "type": "boolean" }, "employerIntroSentAt": { "type": "boolean" }, "defaultFolder": { "type": "boolean" }, "ranking": { "type": "boolean" }, "qualifiedLives": { "type": "boolean" }, "isATest": { "type": "boolean" }, "groupMaster": { "type": "boolean" }, "finalRefundAmount": { "type": "boolean" }, "totalFeePercent": { "type": "boolean" }, "totalFeeAmount": { "type": "boolean" }, "totalFeeType": { "type": "boolean" }, "upfrontFeePercent": { "type": "boolean" }, "upfrontFeeAmount": { "type": "boolean" }, "upfrontFeeType": { "type": "boolean" }, "upfrontFeeDate": { "type": "boolean" }, "depositFeePercent": { "type": "boolean" }, "depositFeeAmount": { "type": "boolean" }, "depositFeeType": { "type": "boolean" }, "depositFeeDate": { "type": "boolean" }, "laterFeePercent": { "type": "boolean" }, "laterFeeAmount": { "type": "boolean" }, "laterFeeType": { "type": "boolean" }, "laterFeeDate": { "type": "boolean" }, "hedgeFundBuyoutPrice": { "type": "boolean" }, "group": { "type": "boolean" }, "feeHedgeFundBuyoutPrice": { "type": "boolean" }, "stripeCustomerId": { "type": "boolean" }, "qbCustomerId": { "type": "boolean" }, "routingNumber": { "type": "boolean" }, "accountNumber": { "type": "boolean" }, "accountHolderName": { "type": "boolean" }, "bankName": { "type": "boolean" }, "clientAddress": { "type": "boolean" }, "affiliateUserId": { "type": "boolean" }, "salesRepId": { "type": "boolean" }, "affiliateManagerId": { "type": "boolean" }, "payrollDataMethod": { "type": "boolean" }, "payrollDataStatus": { "type": "boolean" }, "payrollDataStatusNote": { "type": "boolean" }, "payrollDataStatusUpdatedAt": { "type": "boolean" }, "payrollDataStatusUpdatedById": { "type": "boolean" }, "payrollSubmissionCompleteAt": { "type": "boolean" }, "payrollSubmissionCompleteById": { "type": "boolean" }, "payrollProviderId": { "type": "boolean" }, "usesPeo": { "type": "boolean" }, "subAffiliateUserId": { "type": "boolean" }, "einNumber": { "type": "boolean" }, "businessEntityType": { "type": "boolean" }, "stateOfIncorporation": { "type": "boolean" }, "subSubAffiliateUserId": { "type": "boolean" }, "subSubSubAffiliateUserId": { "type": "boolean" }, "referrerUserId": { "type": "boolean" }, "language": { "type": "boolean" }, "companyType": { "type": "boolean" }, "livesCount": { "type": "boolean" }, "hedgeFundBuyoutCompanyId": { "type": "boolean" }, "feeHedgeFundBuyoutCompanyId": { "type": "boolean" }, "subAffiliateCommissionFee": { "type": "boolean" }, "affiliateCommissionTierOverrideId": { "type": "boolean" }, "charityCompanyId": { "type": "boolean" }, "processorCompanyId": { "type": "boolean" }, "affiliateHasBeenReviewed": { "type": "boolean" }, "affiliateWillPayDownlines": { "type": "boolean" }, "bypassContract": { "type": "boolean" }, "charityPayoutPerLife": { "type": "boolean" }, "isMarketingPartner": { "type": "boolean" }, "autoEnrollEmployees": { "type": "boolean" }, "calcomBookingUrl": { "type": "boolean" }, "affiliateCommissionSetValue": { "type": "boolean" }, "affiliateAmount": { "type": "boolean" }, "salesRepAmount": { "type": "boolean" }, "affiliateManagerAmount": { "type": "boolean" }, "subAffiliateAmount": { "type": "boolean" }, "subSubAffiliateAmount": { "type": "boolean" }, "subSubSubAffiliateAmount": { "type": "boolean" }, "grossWellnessFee": { "type": "boolean" }, "referrer1Id": { "type": "boolean" }, "referrer2Id": { "type": "boolean" }, "referrer3Id": { "type": "boolean" }, "referrer4Id": { "type": "boolean" }, "referrer5Id": { "type": "boolean" }, "referrer6Id": { "type": "boolean" }, "tariffsPaid": { "type": "boolean" }, "tariffsPaidToCountries": { "type": "boolean" }, "tariffIndustry": { "type": "boolean" }, "tariffEntryMethod": { "type": "boolean" }, "tariffComission1": { "type": "boolean" }, "tariffComission2": { "type": "boolean" }, "tariffComission1Sub": { "type": "boolean" }, "tariffComission2Sub": { "type": "boolean" }, "referrer1Amount": { "type": "boolean" }, "referrer2Amount": { "type": "boolean" }, "referrer3Amount": { "type": "boolean" }, "referrer4Amount": { "type": "boolean" }, "referrer5Amount": { "type": "boolean" }, "referrer6Amount": { "type": "boolean" }, "w2Employees": { "type": "boolean" }, "numberOfReferrers": { "type": "boolean" }, "enrolledW2Employees": { "type": "boolean" }, "estimatedTariffIncome": { "type": "boolean" }, "quotedTariffIncome": { "type": "boolean" }, "contractedTariffIncome": { "type": "boolean" }, "campaignFromEmail": { "type": "boolean" }, "campaignFromName": { "type": "boolean" }, "campaignReplyTo": { "type": "boolean" }, "dealState": { "type": "boolean" }, "dealLostReason": { "type": "boolean" }, "dealLostNote": { "type": "boolean" }, "dealLostAt": { "type": "boolean" }, "dealLostById": { "type": "boolean" }, "dealRevivedAt": { "type": "boolean" }, "dealRevivedById": { "type": "boolean" }, "dealTerminalRaisedAt": { "type": "boolean" }, "ladderNudgedAt": { "type": "boolean" }, "ladderNudgedById": { "type": "boolean" }, "employerGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "expectedLiveDate", "goLiveDate", "updatedAt", "address", "city", "zipCode", "bankAddress", "bankCity", "bankState", "bankZipCode", "country", "email", "createdByUserId", "ownedById", "referredByCompanyId", "tenantHost", "name", "phone", "state", "reviewerId", "website", "logoUrl", "logoStatus", "logoCandidateUrl", "logoCandidateDomain", "logoSource", "logoEvidence", "logoReviewedByUserId", "logoReviewedAt", "status", "statusUpdatedAt", "employerPhaseOverride", "trainingCommsSentAt", "employeeInvitesProvisionedAt", "employerIntroSentAt", "defaultFolder", "ranking", "qualifiedLives", "isATest", "groupMaster", "finalRefundAmount", "totalFeePercent", "totalFeeAmount", "totalFeeType", "upfrontFeePercent", "upfrontFeeAmount", "upfrontFeeType", "upfrontFeeDate", "depositFeePercent", "depositFeeAmount", "depositFeeType", "depositFeeDate", "laterFeePercent", "laterFeeAmount", "laterFeeType", "laterFeeDate", "hedgeFundBuyoutPrice", "group", "feeHedgeFundBuyoutPrice", "stripeCustomerId", "qbCustomerId", "routingNumber", "accountNumber", "accountHolderName", "bankName", "clientAddress", "affiliateUserId", "salesRepId", "affiliateManagerId", "payrollDataMethod", "payrollDataStatus", "payrollDataStatusNote", "payrollDataStatusUpdatedAt", "payrollDataStatusUpdatedById", "payrollSubmissionCompleteAt", "payrollSubmissionCompleteById", "payrollProviderId", "usesPeo", "subAffiliateUserId", "einNumber", "businessEntityType", "stateOfIncorporation", "subSubAffiliateUserId", "subSubSubAffiliateUserId", "referrerUserId", "language", "companyType", "livesCount", "hedgeFundBuyoutCompanyId", "feeHedgeFundBuyoutCompanyId", "subAffiliateCommissionFee", "affiliateCommissionTierOverrideId", "charityCompanyId", "processorCompanyId", "affiliateHasBeenReviewed", "affiliateWillPayDownlines", "bypassContract", "charityPayoutPerLife", "isMarketingPartner", "autoEnrollEmployees", "calcomBookingUrl", "affiliateCommissionSetValue", "affiliateAmount", "salesRepAmount", "affiliateManagerAmount", "subAffiliateAmount", "subSubAffiliateAmount", "subSubSubAffiliateAmount", "grossWellnessFee", "referrer1Id", "referrer2Id", "referrer3Id", "referrer4Id", "referrer5Id", "referrer6Id", "tariffsPaid", "tariffsPaidToCountries", "tariffIndustry", "tariffEntryMethod", "tariffComission1", "tariffComission2", "tariffComission1Sub", "tariffComission2Sub", "referrer1Amount", "referrer2Amount", "referrer3Amount", "referrer4Amount", "referrer5Amount", "referrer6Amount", "w2Employees", "numberOfReferrers", "enrolledW2Employees", "estimatedTariffIncome", "quotedTariffIncome", "contractedTariffIncome", "campaignFromEmail", "campaignFromName", "campaignReplyTo", "dealState", "dealLostReason", "dealLostNote", "dealLostAt", "dealLostById", "dealRevivedAt", "dealRevivedById", "dealTerminalRaisedAt", "ladderNudgedAt", "ladderNudgedById", "employerGroupId" ], "example": "id" }, "uniqueItems": true } ], "title": "Company.Fields" }, "include": { "title": "Company.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Company.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Company.Filter1": { "type": "object", "title": "Company.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Company.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "expectedLiveDate": { "type": "boolean" }, "goLiveDate": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "address": { "type": "boolean" }, "city": { "type": "boolean" }, "zipCode": { "type": "boolean" }, "bankAddress": { "type": "boolean" }, "bankCity": { "type": "boolean" }, "bankState": { "type": "boolean" }, "bankZipCode": { "type": "boolean" }, "country": { "type": "boolean" }, "email": { "type": "boolean" }, "createdByUserId": { "type": "boolean" }, "ownedById": { "type": "boolean" }, "referredByCompanyId": { "type": "boolean" }, "tenantHost": { "type": "boolean" }, "name": { "type": "boolean" }, "phone": { "type": "boolean" }, "state": { "type": "boolean" }, "reviewerId": { "type": "boolean" }, "website": { "type": "boolean" }, "logoUrl": { "type": "boolean" }, "logoStatus": { "type": "boolean" }, "logoCandidateUrl": { "type": "boolean" }, "logoCandidateDomain": { "type": "boolean" }, "logoSource": { "type": "boolean" }, "logoEvidence": { "type": "boolean" }, "logoReviewedByUserId": { "type": "boolean" }, "logoReviewedAt": { "type": "boolean" }, "status": { "type": "boolean" }, "statusUpdatedAt": { "type": "boolean" }, "employerPhaseOverride": { "type": "boolean" }, "trainingCommsSentAt": { "type": "boolean" }, "employeeInvitesProvisionedAt": { "type": "boolean" }, "employerIntroSentAt": { "type": "boolean" }, "defaultFolder": { "type": "boolean" }, "ranking": { "type": "boolean" }, "qualifiedLives": { "type": "boolean" }, "isATest": { "type": "boolean" }, "groupMaster": { "type": "boolean" }, "finalRefundAmount": { "type": "boolean" }, "totalFeePercent": { "type": "boolean" }, "totalFeeAmount": { "type": "boolean" }, "totalFeeType": { "type": "boolean" }, "upfrontFeePercent": { "type": "boolean" }, "upfrontFeeAmount": { "type": "boolean" }, "upfrontFeeType": { "type": "boolean" }, "upfrontFeeDate": { "type": "boolean" }, "depositFeePercent": { "type": "boolean" }, "depositFeeAmount": { "type": "boolean" }, "depositFeeType": { "type": "boolean" }, "depositFeeDate": { "type": "boolean" }, "laterFeePercent": { "type": "boolean" }, "laterFeeAmount": { "type": "boolean" }, "laterFeeType": { "type": "boolean" }, "laterFeeDate": { "type": "boolean" }, "hedgeFundBuyoutPrice": { "type": "boolean" }, "group": { "type": "boolean" }, "feeHedgeFundBuyoutPrice": { "type": "boolean" }, "stripeCustomerId": { "type": "boolean" }, "qbCustomerId": { "type": "boolean" }, "routingNumber": { "type": "boolean" }, "accountNumber": { "type": "boolean" }, "accountHolderName": { "type": "boolean" }, "bankName": { "type": "boolean" }, "clientAddress": { "type": "boolean" }, "affiliateUserId": { "type": "boolean" }, "salesRepId": { "type": "boolean" }, "affiliateManagerId": { "type": "boolean" }, "payrollDataMethod": { "type": "boolean" }, "payrollDataStatus": { "type": "boolean" }, "payrollDataStatusNote": { "type": "boolean" }, "payrollDataStatusUpdatedAt": { "type": "boolean" }, "payrollDataStatusUpdatedById": { "type": "boolean" }, "payrollSubmissionCompleteAt": { "type": "boolean" }, "payrollSubmissionCompleteById": { "type": "boolean" }, "payrollProviderId": { "type": "boolean" }, "usesPeo": { "type": "boolean" }, "subAffiliateUserId": { "type": "boolean" }, "einNumber": { "type": "boolean" }, "businessEntityType": { "type": "boolean" }, "stateOfIncorporation": { "type": "boolean" }, "subSubAffiliateUserId": { "type": "boolean" }, "subSubSubAffiliateUserId": { "type": "boolean" }, "referrerUserId": { "type": "boolean" }, "language": { "type": "boolean" }, "companyType": { "type": "boolean" }, "livesCount": { "type": "boolean" }, "hedgeFundBuyoutCompanyId": { "type": "boolean" }, "feeHedgeFundBuyoutCompanyId": { "type": "boolean" }, "subAffiliateCommissionFee": { "type": "boolean" }, "affiliateCommissionTierOverrideId": { "type": "boolean" }, "charityCompanyId": { "type": "boolean" }, "processorCompanyId": { "type": "boolean" }, "affiliateHasBeenReviewed": { "type": "boolean" }, "affiliateWillPayDownlines": { "type": "boolean" }, "bypassContract": { "type": "boolean" }, "charityPayoutPerLife": { "type": "boolean" }, "isMarketingPartner": { "type": "boolean" }, "autoEnrollEmployees": { "type": "boolean" }, "calcomBookingUrl": { "type": "boolean" }, "affiliateCommissionSetValue": { "type": "boolean" }, "affiliateAmount": { "type": "boolean" }, "salesRepAmount": { "type": "boolean" }, "affiliateManagerAmount": { "type": "boolean" }, "subAffiliateAmount": { "type": "boolean" }, "subSubAffiliateAmount": { "type": "boolean" }, "subSubSubAffiliateAmount": { "type": "boolean" }, "grossWellnessFee": { "type": "boolean" }, "referrer1Id": { "type": "boolean" }, "referrer2Id": { "type": "boolean" }, "referrer3Id": { "type": "boolean" }, "referrer4Id": { "type": "boolean" }, "referrer5Id": { "type": "boolean" }, "referrer6Id": { "type": "boolean" }, "tariffsPaid": { "type": "boolean" }, "tariffsPaidToCountries": { "type": "boolean" }, "tariffIndustry": { "type": "boolean" }, "tariffEntryMethod": { "type": "boolean" }, "tariffComission1": { "type": "boolean" }, "tariffComission2": { "type": "boolean" }, "tariffComission1Sub": { "type": "boolean" }, "tariffComission2Sub": { "type": "boolean" }, "referrer1Amount": { "type": "boolean" }, "referrer2Amount": { "type": "boolean" }, "referrer3Amount": { "type": "boolean" }, "referrer4Amount": { "type": "boolean" }, "referrer5Amount": { "type": "boolean" }, "referrer6Amount": { "type": "boolean" }, "w2Employees": { "type": "boolean" }, "numberOfReferrers": { "type": "boolean" }, "enrolledW2Employees": { "type": "boolean" }, "estimatedTariffIncome": { "type": "boolean" }, "quotedTariffIncome": { "type": "boolean" }, "contractedTariffIncome": { "type": "boolean" }, "campaignFromEmail": { "type": "boolean" }, "campaignFromName": { "type": "boolean" }, "campaignReplyTo": { "type": "boolean" }, "dealState": { "type": "boolean" }, "dealLostReason": { "type": "boolean" }, "dealLostNote": { "type": "boolean" }, "dealLostAt": { "type": "boolean" }, "dealLostById": { "type": "boolean" }, "dealRevivedAt": { "type": "boolean" }, "dealRevivedById": { "type": "boolean" }, "dealTerminalRaisedAt": { "type": "boolean" }, "ladderNudgedAt": { "type": "boolean" }, "ladderNudgedById": { "type": "boolean" }, "employerGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "expectedLiveDate", "goLiveDate", "updatedAt", "address", "city", "zipCode", "bankAddress", "bankCity", "bankState", "bankZipCode", "country", "email", "createdByUserId", "ownedById", "referredByCompanyId", "tenantHost", "name", "phone", "state", "reviewerId", "website", "logoUrl", "logoStatus", "logoCandidateUrl", "logoCandidateDomain", "logoSource", "logoEvidence", "logoReviewedByUserId", "logoReviewedAt", "status", "statusUpdatedAt", "employerPhaseOverride", "trainingCommsSentAt", "employeeInvitesProvisionedAt", "employerIntroSentAt", "defaultFolder", "ranking", "qualifiedLives", "isATest", "groupMaster", "finalRefundAmount", "totalFeePercent", "totalFeeAmount", "totalFeeType", "upfrontFeePercent", "upfrontFeeAmount", "upfrontFeeType", "upfrontFeeDate", "depositFeePercent", "depositFeeAmount", "depositFeeType", "depositFeeDate", "laterFeePercent", "laterFeeAmount", "laterFeeType", "laterFeeDate", "hedgeFundBuyoutPrice", "group", "feeHedgeFundBuyoutPrice", "stripeCustomerId", "qbCustomerId", "routingNumber", "accountNumber", "accountHolderName", "bankName", "clientAddress", "affiliateUserId", "salesRepId", "affiliateManagerId", "payrollDataMethod", "payrollDataStatus", "payrollDataStatusNote", "payrollDataStatusUpdatedAt", "payrollDataStatusUpdatedById", "payrollSubmissionCompleteAt", "payrollSubmissionCompleteById", "payrollProviderId", "usesPeo", "subAffiliateUserId", "einNumber", "businessEntityType", "stateOfIncorporation", "subSubAffiliateUserId", "subSubSubAffiliateUserId", "referrerUserId", "language", "companyType", "livesCount", "hedgeFundBuyoutCompanyId", "feeHedgeFundBuyoutCompanyId", "subAffiliateCommissionFee", "affiliateCommissionTierOverrideId", "charityCompanyId", "processorCompanyId", "affiliateHasBeenReviewed", "affiliateWillPayDownlines", "bypassContract", "charityPayoutPerLife", "isMarketingPartner", "autoEnrollEmployees", "calcomBookingUrl", "affiliateCommissionSetValue", "affiliateAmount", "salesRepAmount", "affiliateManagerAmount", "subAffiliateAmount", "subSubAffiliateAmount", "subSubSubAffiliateAmount", "grossWellnessFee", "referrer1Id", "referrer2Id", "referrer3Id", "referrer4Id", "referrer5Id", "referrer6Id", "tariffsPaid", "tariffsPaidToCountries", "tariffIndustry", "tariffEntryMethod", "tariffComission1", "tariffComission2", "tariffComission1Sub", "tariffComission2Sub", "referrer1Amount", "referrer2Amount", "referrer3Amount", "referrer4Amount", "referrer5Amount", "referrer6Amount", "w2Employees", "numberOfReferrers", "enrolledW2Employees", "estimatedTariffIncome", "quotedTariffIncome", "contractedTariffIncome", "campaignFromEmail", "campaignFromName", "campaignReplyTo", "dealState", "dealLostReason", "dealLostNote", "dealLostAt", "dealLostById", "dealRevivedAt", "dealRevivedById", "dealTerminalRaisedAt", "ladderNudgedAt", "ladderNudgedById", "employerGroupId" ], "example": "id" }, "uniqueItems": true } ], "title": "Company.Fields" }, "include": { "title": "Company.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Company.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyGroup.Filter": { "type": "object", "title": "CompanyGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "masterCompany": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "masterCompany", "name" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyGroup.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyGroup.Filter1": { "type": "object", "title": "CompanyGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CompanyGroup.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "masterCompany": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "masterCompany", "name" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyGroup.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyLocations.Filter": { "type": "object", "title": "CompanyLocations.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "city": { "type": "boolean" }, "state": { "type": "boolean" }, "notes": { "type": "boolean" }, "percentOfBusiness": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "city", "state", "notes", "percentOfBusiness" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyLocations.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyLocations.Filter1": { "type": "object", "title": "CompanyLocations.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CompanyLocations.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "city": { "type": "boolean" }, "state": { "type": "boolean" }, "notes": { "type": "boolean" }, "percentOfBusiness": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "city", "state", "notes", "percentOfBusiness" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyLocations.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyMandateAssignment.Filter": { "type": "object", "title": "CompanyMandateAssignment.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "companyId": { "type": "boolean" }, "mandateId": { "type": "boolean" }, "mandateEffectId": { "type": "boolean" }, "industryGroupId": { "type": "boolean" }, "suggestedByAi": { "type": "boolean" }, "status": { "type": "boolean" }, "impact": { "type": "boolean" }, "rejectionReason": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "companyId", "mandateId", "mandateEffectId", "industryGroupId", "suggestedByAi", "status", "impact", "rejectionReason" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyMandateAssignment.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyMandateAssignment.Filter1": { "type": "object", "title": "CompanyMandateAssignment.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CompanyMandateAssignment.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "companyId": { "type": "boolean" }, "mandateId": { "type": "boolean" }, "mandateEffectId": { "type": "boolean" }, "industryGroupId": { "type": "boolean" }, "suggestedByAi": { "type": "boolean" }, "status": { "type": "boolean" }, "impact": { "type": "boolean" }, "rejectionReason": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "companyId", "mandateId", "mandateEffectId", "industryGroupId", "suggestedByAi", "status", "impact", "rejectionReason" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyMandateAssignment.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyProductStage.Filter": { "type": "object", "title": "CompanyProductStage.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "stageId": { "type": "boolean" }, "lastUpdated": { "type": "boolean" }, "updatedByUser": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "stageId", "lastUpdated", "updatedByUser" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyProductStage.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyProductStage.Filter1": { "type": "object", "title": "CompanyProductStage.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CompanyProductStage.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "stageId": { "type": "boolean" }, "lastUpdated": { "type": "boolean" }, "updatedByUser": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "stageId", "lastUpdated", "updatedByUser" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyProductStage.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyRepairStages.Filter": { "type": "object", "title": "CompanyRepairStages.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "stage": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "stage" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyRepairStages.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyRepairStages.Filter1": { "type": "object", "title": "CompanyRepairStages.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CompanyRepairStages.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "stage": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "stage" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyRepairStages.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompanyReviewUsers.Filter": { "type": "object", "title": "CompanyReviewUsers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CompanyReviewUsers.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "isNextReviewer": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "isNextReviewer" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyReviewUsers.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "WatchCompany": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number" } }, "title": "WatchCompany" }, "CompanyWatchers.Filter": { "type": "object", "title": "CompanyWatchers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CompanyWatchers.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "userId": { "type": "boolean" }, "createdAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "userId", "createdAt" ], "example": "id" }, "uniqueItems": true } ], "title": "CompanyWatchers.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ComparrisonTypes.Filter": { "type": "object", "title": "ComparrisonTypes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" }, "usesField_2": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "name", "usesField_2" ], "example": "description" }, "uniqueItems": true } ], "title": "ComparrisonTypes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ComparrisonTypes.Filter1": { "type": "object", "title": "ComparrisonTypes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ComparrisonTypes.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" }, "usesField_2": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "name", "usesField_2" ], "example": "description" }, "uniqueItems": true } ], "title": "ComparrisonTypes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DashboardLayoutSave": { "type": "object", "required": [ "version", "modules" ], "properties": { "version": { "type": "number" }, "modules": { "type": "array", "items": { "type": "object", "required": [ "id", "hidden" ], "properties": { "id": { "type": "string" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" } } } }, "layouts": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "required": [ "i", "x", "y", "w", "h" ], "properties": { "i": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" } } } } } }, "title": "DashboardLayoutSave" }, "DealTagOptions.Filter": { "type": "object", "title": "DealTagOptions.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "fieldName": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "fieldName" ], "example": "id" }, "uniqueItems": true } ], "title": "DealTagOptions.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DealTagOptions.Filter1": { "type": "object", "title": "DealTagOptions.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "DealTagOptions.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "fieldName": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "fieldName" ], "example": "id" }, "uniqueItems": true } ], "title": "DealTagOptions.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DealTags.Filter": { "type": "object", "title": "DealTags.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "dealId": { "type": "boolean" }, "tagId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "dealId", "tagId" ], "example": "id" }, "uniqueItems": true } ], "title": "DealTags.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DealTags.Filter1": { "type": "object", "title": "DealTags.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "DealTags.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "dealId": { "type": "boolean" }, "tagId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "dealId", "tagId" ], "example": "id" }, "uniqueItems": true } ], "title": "DealTags.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Deals.Filter": { "type": "object", "title": "Deals.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyName": { "type": "boolean" }, "isAPeo": { "type": "boolean" }, "dealPayType": { "type": "boolean" }, "feePercentage": { "type": "boolean" }, "dealPayStatus": { "type": "boolean" }, "wasTheDealFinanced": { "type": "boolean" }, "didTheIrsIssueARefundFullPartialOrNone": { "type": "boolean" }, "clientRefundAmountBasedOn_941XsBeforeInterest": { "type": "boolean" }, "clearErcFees": { "type": "boolean" }, "amountPaid": { "type": "boolean" }, "amountStillOwed": { "type": "boolean" }, "q2_2020_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ2_2020": { "type": "boolean" }, "anyIssuesWithQ2_2020IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ2_2020": { "type": "boolean" }, "didTheIrsIssueARefundForQ2_2020": { "type": "boolean" }, "amountOfRefundIssuedForQ2_2020": { "type": "boolean" }, "q3_2020_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ3_2020": { "type": "boolean" }, "issuesWithQ3_2020IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ3_2020": { "type": "boolean" }, "didTheIrsIssueARefundForQ3_2020": { "type": "boolean" }, "amountOfRefundIssuedForQ3_2020": { "type": "boolean" }, "q4_2020_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ4_2020": { "type": "boolean" }, "anyIssuesWithQ4_2020IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ4_2020": { "type": "boolean" }, "didTheIrsIssueARefundForQ4_2020": { "type": "boolean" }, "amountOfRefundIssuedForQ4_2020": { "type": "boolean" }, "taxLiabilityQ2_2020": { "type": "boolean" }, "taxLiabilityQ4_2021": { "type": "boolean" }, "taxLiabilityQ3_2020": { "type": "boolean" }, "taxLiabilityQ4_2020": { "type": "boolean" }, "taxLiabilityQ2_2021": { "type": "boolean" }, "taxLiabilityQ1_2021": { "type": "boolean" }, "taxLiabilityQ3_2021": { "type": "boolean" }, "q1_2021_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ1_2021": { "type": "boolean" }, "anyIssuesWithQ1_2021IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ1_2021": { "type": "boolean" }, "didTheIrsIssueARefundForQ1_2021": { "type": "boolean" }, "amountOfRefundIssuedForQ1_2021": { "type": "boolean" }, "q2_2021_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ2_2021": { "type": "boolean" }, "anyIssuesWithQ2_2021IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ2_2021": { "type": "boolean" }, "didTheIrsIssueARefundForQ2_2021": { "type": "boolean" }, "amountOfRefundIssuedForQ2_2021": { "type": "boolean" }, "didWeFileQ3_941X": { "type": "boolean" }, "q3_2021_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ3_2021": { "type": "boolean" }, "anyIssuesWithQ3_2021IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ3_2021": { "type": "boolean" }, "didTheIrsIssueARefundForQ3_2021": { "type": "boolean" }, "amountOfRefundIssuedForQ3_2021": { "type": "boolean" }, "wasThereAQ3Disallowance": { "type": "boolean" }, "amountStillOwedWithoutQ3": { "type": "boolean" }, "q3MoneyThatWeMayHaveToRefund": { "type": "boolean" }, "q4_2021_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ4_2021": { "type": "boolean" }, "anyIssuesWithQ4_2021IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ4_2021": { "type": "boolean" }, "didTheIrsIssueARefundForQ4_2021": { "type": "boolean" }, "amountOfRefundIssuedForQ4_2021": { "type": "boolean" }, "totalRefundsIssued": { "type": "boolean" }, "isThereATaxLiability": { "type": "boolean" }, "howMuchOfErcCreditTransferredDueToTaxLiability": { "type": "boolean" }, "isThereMonitoring": { "type": "boolean" }, "whatTypeOfMonitoring": { "type": "boolean" }, "affliateGroupTeam": { "type": "boolean" }, "affiliateOnAccount": { "type": "boolean" }, "mainAffiliateName": { "type": "boolean" }, "mainAffiliatePercentage": { "type": "boolean" }, "mainAffiliateCommissionsBasedOnAmountRefunded": { "type": "boolean" }, "totalMainAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "boolean" }, "currentPaidMainAffiliateCommission": { "type": "boolean" }, "currentStillOwedMainAffiliateCommission": { "type": "boolean" }, "totalMainAffiliateCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "potentialFutureStillOwedMainAffiliateCommission": { "type": "boolean" }, "subAffiliateName": { "type": "boolean" }, "subAffiliatePercentage": { "type": "boolean" }, "subAffiliateCommissionBasedOnAmountRefunded": { "type": "boolean" }, "totalSubAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "boolean" }, "currentPaidSubAffiliateCommission": { "type": "boolean" }, "currentStillOwedSubAffiliateCommission": { "type": "boolean" }, "totalSubAffiliateCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "potentialFutureStillOwedSubAffiliateCommission": { "type": "boolean" }, "mikesRelatedCommissionPercentage": { "type": "boolean" }, "amountDueToMikeBasedOnAmountRefunded": { "type": "boolean" }, "totalMikesCommissionDueBasedOnFeesAlreadyPaid": { "type": "boolean" }, "currentPaidMikesCommission": { "type": "boolean" }, "currentStillOwedMikesCommission": { "type": "boolean" }, "totalMikesCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "potentialFutureStillOwedMikesAffiliateCommission": { "type": "boolean" }, "jacobsRelatedCommissionPercentage": { "type": "boolean" }, "amountDueToJacobBasedOnAmountRefunded": { "type": "boolean" }, "totalJacobsCommissionDueBasedOnFeesAlreadyPaid": { "type": "boolean" }, "currentPaidJacobsCommission": { "type": "boolean" }, "currentStillOwedJacobsCommission": { "type": "boolean" }, "totalJacobsCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "potentialFutureStillOwedJacobsAffiliateCommission": { "type": "boolean" }, "tomsRelatedCommissionPercentage": { "type": "boolean" }, "amountDueToTomBasedOnAmountRefunded": { "type": "boolean" }, "totalTomsCommissionDueBasedOnFeesAlreadyPaid": { "type": "boolean" }, "currentPaidTomsCommission": { "type": "boolean" }, "currentStillOwedTomsCommission": { "type": "boolean" }, "totalTomsCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "potentialFutureStillOwedTomsAffiliateCommission": { "type": "boolean" }, "totalCommissionDue": { "type": "boolean" }, "totalPaidCommission": { "type": "boolean" }, "totalCurrentStillOwedCommission": { "type": "boolean" }, "totalCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "totalPotentialFutureStillOwedAffiliateCommission": { "type": "boolean" }, "totalCommissionPercentage": { "type": "boolean" }, "cpaOnFile": { "type": "boolean" }, "totalCpaCosts": { "type": "boolean" }, "cpaCostsPaid": { "type": "boolean" }, "cpaCostsStillOwed": { "type": "boolean" }, "totalTaxAttorneyCosts": { "type": "boolean" }, "taxAttorneyCostsPaid": { "type": "boolean" }, "taxAttorneyCostsOwed": { "type": "boolean" }, "totalOtherCosts": { "type": "boolean" }, "otherCostsPaid": { "type": "boolean" }, "otherCostsStillOwed": { "type": "boolean" }, "totalCommissionsAndCosts": { "type": "boolean" }, "netRevenueWithQ3": { "type": "boolean" }, "netRevenueAsAPercentageOfFeesWithQ3": { "type": "boolean" }, "netRevenueWithoutQ3": { "type": "boolean" }, "netRevenueAsAPercentageOfFeesWithoutQ3": { "type": "boolean" }, "isThereAContract": { "type": "boolean" }, "isThereAClawbackContract": { "type": "boolean" }, "wasThereARequestForMoneyBack": { "type": "boolean" }, "doesTheFileHaveASubstantiationPackage": { "type": "boolean" }, "estimatedFutureCostToSubstantiateFile": { "type": "boolean" }, "affiliateRefundLiabilityForAmountAlreadyPaid": { "type": "boolean" }, "cpaFutureMaintenanceAndAppealCosts": { "type": "boolean" }, "taxAttorneyProjectedCosts": { "type": "boolean" }, "estimatedFlatRateToFixAFile": { "type": "boolean" }, "estimatedPastInHouseCosts": { "type": "boolean" }, "estimatedFutureInhouseCostsAt_40kPerMonthFor_5yrs": { "type": "boolean" }, "isBadDeal": { "type": "boolean" }, "linkToFolder": { "type": "boolean" }, "folderHref": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyName", "isAPeo", "dealPayType", "feePercentage", "dealPayStatus", "wasTheDealFinanced", "didTheIrsIssueARefundFullPartialOrNone", "clientRefundAmountBasedOn_941XsBeforeInterest", "clearErcFees", "amountPaid", "amountStillOwed", "q2_2020_941XAmountFiled", "didIrsRecieveQ2_2020", "anyIssuesWithQ2_2020IrsTranscripts", "amountOnFileWithTheIrsForQ2_2020", "didTheIrsIssueARefundForQ2_2020", "amountOfRefundIssuedForQ2_2020", "q3_2020_941XAmountFiled", "didIrsRecieveQ3_2020", "issuesWithQ3_2020IrsTranscripts", "amountOnFileWithTheIrsForQ3_2020", "didTheIrsIssueARefundForQ3_2020", "amountOfRefundIssuedForQ3_2020", "q4_2020_941XAmountFiled", "didIrsRecieveQ4_2020", "anyIssuesWithQ4_2020IrsTranscripts", "amountOnFileWithTheIrsForQ4_2020", "didTheIrsIssueARefundForQ4_2020", "amountOfRefundIssuedForQ4_2020", "taxLiabilityQ2_2020", "taxLiabilityQ4_2021", "taxLiabilityQ3_2020", "taxLiabilityQ4_2020", "taxLiabilityQ2_2021", "taxLiabilityQ1_2021", "taxLiabilityQ3_2021", "q1_2021_941XAmountFiled", "didIrsRecieveQ1_2021", "anyIssuesWithQ1_2021IrsTranscripts", "amountOnFileWithTheIrsForQ1_2021", "didTheIrsIssueARefundForQ1_2021", "amountOfRefundIssuedForQ1_2021", "q2_2021_941XAmountFiled", "didIrsRecieveQ2_2021", "anyIssuesWithQ2_2021IrsTranscripts", "amountOnFileWithTheIrsForQ2_2021", "didTheIrsIssueARefundForQ2_2021", "amountOfRefundIssuedForQ2_2021", "didWeFileQ3_941X", "q3_2021_941XAmountFiled", "didIrsRecieveQ3_2021", "anyIssuesWithQ3_2021IrsTranscripts", "amountOnFileWithTheIrsForQ3_2021", "didTheIrsIssueARefundForQ3_2021", "amountOfRefundIssuedForQ3_2021", "wasThereAQ3Disallowance", "amountStillOwedWithoutQ3", "q3MoneyThatWeMayHaveToRefund", "q4_2021_941XAmountFiled", "didIrsRecieveQ4_2021", "anyIssuesWithQ4_2021IrsTranscripts", "amountOnFileWithTheIrsForQ4_2021", "didTheIrsIssueARefundForQ4_2021", "amountOfRefundIssuedForQ4_2021", "totalRefundsIssued", "isThereATaxLiability", "howMuchOfErcCreditTransferredDueToTaxLiability", "isThereMonitoring", "whatTypeOfMonitoring", "affliateGroupTeam", "affiliateOnAccount", "mainAffiliateName", "mainAffiliatePercentage", "mainAffiliateCommissionsBasedOnAmountRefunded", "totalMainAffiliateCommissionDueBasedOnFeesAlreadyPaid", "currentPaidMainAffiliateCommission", "currentStillOwedMainAffiliateCommission", "totalMainAffiliateCommissionBasedOnOverallClearErcFees", "potentialFutureStillOwedMainAffiliateCommission", "subAffiliateName", "subAffiliatePercentage", "subAffiliateCommissionBasedOnAmountRefunded", "totalSubAffiliateCommissionDueBasedOnFeesAlreadyPaid", "currentPaidSubAffiliateCommission", "currentStillOwedSubAffiliateCommission", "totalSubAffiliateCommissionBasedOnOverallClearErcFees", "potentialFutureStillOwedSubAffiliateCommission", "mikesRelatedCommissionPercentage", "amountDueToMikeBasedOnAmountRefunded", "totalMikesCommissionDueBasedOnFeesAlreadyPaid", "currentPaidMikesCommission", "currentStillOwedMikesCommission", "totalMikesCommissionBasedOnOverallClearErcFees", "potentialFutureStillOwedMikesAffiliateCommission", "jacobsRelatedCommissionPercentage", "amountDueToJacobBasedOnAmountRefunded", "totalJacobsCommissionDueBasedOnFeesAlreadyPaid", "currentPaidJacobsCommission", "currentStillOwedJacobsCommission", "totalJacobsCommissionBasedOnOverallClearErcFees", "potentialFutureStillOwedJacobsAffiliateCommission", "tomsRelatedCommissionPercentage", "amountDueToTomBasedOnAmountRefunded", "totalTomsCommissionDueBasedOnFeesAlreadyPaid", "currentPaidTomsCommission", "currentStillOwedTomsCommission", "totalTomsCommissionBasedOnOverallClearErcFees", "potentialFutureStillOwedTomsAffiliateCommission", "totalCommissionDue", "totalPaidCommission", "totalCurrentStillOwedCommission", "totalCommissionBasedOnOverallClearErcFees", "totalPotentialFutureStillOwedAffiliateCommission", "totalCommissionPercentage", "cpaOnFile", "totalCpaCosts", "cpaCostsPaid", "cpaCostsStillOwed", "totalTaxAttorneyCosts", "taxAttorneyCostsPaid", "taxAttorneyCostsOwed", "totalOtherCosts", "otherCostsPaid", "otherCostsStillOwed", "totalCommissionsAndCosts", "netRevenueWithQ3", "netRevenueAsAPercentageOfFeesWithQ3", "netRevenueWithoutQ3", "netRevenueAsAPercentageOfFeesWithoutQ3", "isThereAContract", "isThereAClawbackContract", "wasThereARequestForMoneyBack", "doesTheFileHaveASubstantiationPackage", "estimatedFutureCostToSubstantiateFile", "affiliateRefundLiabilityForAmountAlreadyPaid", "cpaFutureMaintenanceAndAppealCosts", "taxAttorneyProjectedCosts", "estimatedFlatRateToFixAFile", "estimatedPastInHouseCosts", "estimatedFutureInhouseCostsAt_40kPerMonthFor_5yrs", "isBadDeal", "linkToFolder", "folderHref" ], "example": "id" }, "uniqueItems": true } ], "title": "Deals.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Deals.Filter1": { "type": "object", "title": "Deals.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Deals.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyName": { "type": "boolean" }, "isAPeo": { "type": "boolean" }, "dealPayType": { "type": "boolean" }, "feePercentage": { "type": "boolean" }, "dealPayStatus": { "type": "boolean" }, "wasTheDealFinanced": { "type": "boolean" }, "didTheIrsIssueARefundFullPartialOrNone": { "type": "boolean" }, "clientRefundAmountBasedOn_941XsBeforeInterest": { "type": "boolean" }, "clearErcFees": { "type": "boolean" }, "amountPaid": { "type": "boolean" }, "amountStillOwed": { "type": "boolean" }, "q2_2020_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ2_2020": { "type": "boolean" }, "anyIssuesWithQ2_2020IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ2_2020": { "type": "boolean" }, "didTheIrsIssueARefundForQ2_2020": { "type": "boolean" }, "amountOfRefundIssuedForQ2_2020": { "type": "boolean" }, "q3_2020_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ3_2020": { "type": "boolean" }, "issuesWithQ3_2020IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ3_2020": { "type": "boolean" }, "didTheIrsIssueARefundForQ3_2020": { "type": "boolean" }, "amountOfRefundIssuedForQ3_2020": { "type": "boolean" }, "q4_2020_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ4_2020": { "type": "boolean" }, "anyIssuesWithQ4_2020IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ4_2020": { "type": "boolean" }, "didTheIrsIssueARefundForQ4_2020": { "type": "boolean" }, "amountOfRefundIssuedForQ4_2020": { "type": "boolean" }, "taxLiabilityQ2_2020": { "type": "boolean" }, "taxLiabilityQ4_2021": { "type": "boolean" }, "taxLiabilityQ3_2020": { "type": "boolean" }, "taxLiabilityQ4_2020": { "type": "boolean" }, "taxLiabilityQ2_2021": { "type": "boolean" }, "taxLiabilityQ1_2021": { "type": "boolean" }, "taxLiabilityQ3_2021": { "type": "boolean" }, "q1_2021_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ1_2021": { "type": "boolean" }, "anyIssuesWithQ1_2021IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ1_2021": { "type": "boolean" }, "didTheIrsIssueARefundForQ1_2021": { "type": "boolean" }, "amountOfRefundIssuedForQ1_2021": { "type": "boolean" }, "q2_2021_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ2_2021": { "type": "boolean" }, "anyIssuesWithQ2_2021IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ2_2021": { "type": "boolean" }, "didTheIrsIssueARefundForQ2_2021": { "type": "boolean" }, "amountOfRefundIssuedForQ2_2021": { "type": "boolean" }, "didWeFileQ3_941X": { "type": "boolean" }, "q3_2021_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ3_2021": { "type": "boolean" }, "anyIssuesWithQ3_2021IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ3_2021": { "type": "boolean" }, "didTheIrsIssueARefundForQ3_2021": { "type": "boolean" }, "amountOfRefundIssuedForQ3_2021": { "type": "boolean" }, "wasThereAQ3Disallowance": { "type": "boolean" }, "amountStillOwedWithoutQ3": { "type": "boolean" }, "q3MoneyThatWeMayHaveToRefund": { "type": "boolean" }, "q4_2021_941XAmountFiled": { "type": "boolean" }, "didIrsRecieveQ4_2021": { "type": "boolean" }, "anyIssuesWithQ4_2021IrsTranscripts": { "type": "boolean" }, "amountOnFileWithTheIrsForQ4_2021": { "type": "boolean" }, "didTheIrsIssueARefundForQ4_2021": { "type": "boolean" }, "amountOfRefundIssuedForQ4_2021": { "type": "boolean" }, "totalRefundsIssued": { "type": "boolean" }, "isThereATaxLiability": { "type": "boolean" }, "howMuchOfErcCreditTransferredDueToTaxLiability": { "type": "boolean" }, "isThereMonitoring": { "type": "boolean" }, "whatTypeOfMonitoring": { "type": "boolean" }, "affliateGroupTeam": { "type": "boolean" }, "affiliateOnAccount": { "type": "boolean" }, "mainAffiliateName": { "type": "boolean" }, "mainAffiliatePercentage": { "type": "boolean" }, "mainAffiliateCommissionsBasedOnAmountRefunded": { "type": "boolean" }, "totalMainAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "boolean" }, "currentPaidMainAffiliateCommission": { "type": "boolean" }, "currentStillOwedMainAffiliateCommission": { "type": "boolean" }, "totalMainAffiliateCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "potentialFutureStillOwedMainAffiliateCommission": { "type": "boolean" }, "subAffiliateName": { "type": "boolean" }, "subAffiliatePercentage": { "type": "boolean" }, "subAffiliateCommissionBasedOnAmountRefunded": { "type": "boolean" }, "totalSubAffiliateCommissionDueBasedOnFeesAlreadyPaid": { "type": "boolean" }, "currentPaidSubAffiliateCommission": { "type": "boolean" }, "currentStillOwedSubAffiliateCommission": { "type": "boolean" }, "totalSubAffiliateCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "potentialFutureStillOwedSubAffiliateCommission": { "type": "boolean" }, "mikesRelatedCommissionPercentage": { "type": "boolean" }, "amountDueToMikeBasedOnAmountRefunded": { "type": "boolean" }, "totalMikesCommissionDueBasedOnFeesAlreadyPaid": { "type": "boolean" }, "currentPaidMikesCommission": { "type": "boolean" }, "currentStillOwedMikesCommission": { "type": "boolean" }, "totalMikesCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "potentialFutureStillOwedMikesAffiliateCommission": { "type": "boolean" }, "jacobsRelatedCommissionPercentage": { "type": "boolean" }, "amountDueToJacobBasedOnAmountRefunded": { "type": "boolean" }, "totalJacobsCommissionDueBasedOnFeesAlreadyPaid": { "type": "boolean" }, "currentPaidJacobsCommission": { "type": "boolean" }, "currentStillOwedJacobsCommission": { "type": "boolean" }, "totalJacobsCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "potentialFutureStillOwedJacobsAffiliateCommission": { "type": "boolean" }, "tomsRelatedCommissionPercentage": { "type": "boolean" }, "amountDueToTomBasedOnAmountRefunded": { "type": "boolean" }, "totalTomsCommissionDueBasedOnFeesAlreadyPaid": { "type": "boolean" }, "currentPaidTomsCommission": { "type": "boolean" }, "currentStillOwedTomsCommission": { "type": "boolean" }, "totalTomsCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "potentialFutureStillOwedTomsAffiliateCommission": { "type": "boolean" }, "totalCommissionDue": { "type": "boolean" }, "totalPaidCommission": { "type": "boolean" }, "totalCurrentStillOwedCommission": { "type": "boolean" }, "totalCommissionBasedOnOverallClearErcFees": { "type": "boolean" }, "totalPotentialFutureStillOwedAffiliateCommission": { "type": "boolean" }, "totalCommissionPercentage": { "type": "boolean" }, "cpaOnFile": { "type": "boolean" }, "totalCpaCosts": { "type": "boolean" }, "cpaCostsPaid": { "type": "boolean" }, "cpaCostsStillOwed": { "type": "boolean" }, "totalTaxAttorneyCosts": { "type": "boolean" }, "taxAttorneyCostsPaid": { "type": "boolean" }, "taxAttorneyCostsOwed": { "type": "boolean" }, "totalOtherCosts": { "type": "boolean" }, "otherCostsPaid": { "type": "boolean" }, "otherCostsStillOwed": { "type": "boolean" }, "totalCommissionsAndCosts": { "type": "boolean" }, "netRevenueWithQ3": { "type": "boolean" }, "netRevenueAsAPercentageOfFeesWithQ3": { "type": "boolean" }, "netRevenueWithoutQ3": { "type": "boolean" }, "netRevenueAsAPercentageOfFeesWithoutQ3": { "type": "boolean" }, "isThereAContract": { "type": "boolean" }, "isThereAClawbackContract": { "type": "boolean" }, "wasThereARequestForMoneyBack": { "type": "boolean" }, "doesTheFileHaveASubstantiationPackage": { "type": "boolean" }, "estimatedFutureCostToSubstantiateFile": { "type": "boolean" }, "affiliateRefundLiabilityForAmountAlreadyPaid": { "type": "boolean" }, "cpaFutureMaintenanceAndAppealCosts": { "type": "boolean" }, "taxAttorneyProjectedCosts": { "type": "boolean" }, "estimatedFlatRateToFixAFile": { "type": "boolean" }, "estimatedPastInHouseCosts": { "type": "boolean" }, "estimatedFutureInhouseCostsAt_40kPerMonthFor_5yrs": { "type": "boolean" }, "isBadDeal": { "type": "boolean" }, "linkToFolder": { "type": "boolean" }, "folderHref": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyName", "isAPeo", "dealPayType", "feePercentage", "dealPayStatus", "wasTheDealFinanced", "didTheIrsIssueARefundFullPartialOrNone", "clientRefundAmountBasedOn_941XsBeforeInterest", "clearErcFees", "amountPaid", "amountStillOwed", "q2_2020_941XAmountFiled", "didIrsRecieveQ2_2020", "anyIssuesWithQ2_2020IrsTranscripts", "amountOnFileWithTheIrsForQ2_2020", "didTheIrsIssueARefundForQ2_2020", "amountOfRefundIssuedForQ2_2020", "q3_2020_941XAmountFiled", "didIrsRecieveQ3_2020", "issuesWithQ3_2020IrsTranscripts", "amountOnFileWithTheIrsForQ3_2020", "didTheIrsIssueARefundForQ3_2020", "amountOfRefundIssuedForQ3_2020", "q4_2020_941XAmountFiled", "didIrsRecieveQ4_2020", "anyIssuesWithQ4_2020IrsTranscripts", "amountOnFileWithTheIrsForQ4_2020", "didTheIrsIssueARefundForQ4_2020", "amountOfRefundIssuedForQ4_2020", "taxLiabilityQ2_2020", "taxLiabilityQ4_2021", "taxLiabilityQ3_2020", "taxLiabilityQ4_2020", "taxLiabilityQ2_2021", "taxLiabilityQ1_2021", "taxLiabilityQ3_2021", "q1_2021_941XAmountFiled", "didIrsRecieveQ1_2021", "anyIssuesWithQ1_2021IrsTranscripts", "amountOnFileWithTheIrsForQ1_2021", "didTheIrsIssueARefundForQ1_2021", "amountOfRefundIssuedForQ1_2021", "q2_2021_941XAmountFiled", "didIrsRecieveQ2_2021", "anyIssuesWithQ2_2021IrsTranscripts", "amountOnFileWithTheIrsForQ2_2021", "didTheIrsIssueARefundForQ2_2021", "amountOfRefundIssuedForQ2_2021", "didWeFileQ3_941X", "q3_2021_941XAmountFiled", "didIrsRecieveQ3_2021", "anyIssuesWithQ3_2021IrsTranscripts", "amountOnFileWithTheIrsForQ3_2021", "didTheIrsIssueARefundForQ3_2021", "amountOfRefundIssuedForQ3_2021", "wasThereAQ3Disallowance", "amountStillOwedWithoutQ3", "q3MoneyThatWeMayHaveToRefund", "q4_2021_941XAmountFiled", "didIrsRecieveQ4_2021", "anyIssuesWithQ4_2021IrsTranscripts", "amountOnFileWithTheIrsForQ4_2021", "didTheIrsIssueARefundForQ4_2021", "amountOfRefundIssuedForQ4_2021", "totalRefundsIssued", "isThereATaxLiability", "howMuchOfErcCreditTransferredDueToTaxLiability", "isThereMonitoring", "whatTypeOfMonitoring", "affliateGroupTeam", "affiliateOnAccount", "mainAffiliateName", "mainAffiliatePercentage", "mainAffiliateCommissionsBasedOnAmountRefunded", "totalMainAffiliateCommissionDueBasedOnFeesAlreadyPaid", "currentPaidMainAffiliateCommission", "currentStillOwedMainAffiliateCommission", "totalMainAffiliateCommissionBasedOnOverallClearErcFees", "potentialFutureStillOwedMainAffiliateCommission", "subAffiliateName", "subAffiliatePercentage", "subAffiliateCommissionBasedOnAmountRefunded", "totalSubAffiliateCommissionDueBasedOnFeesAlreadyPaid", "currentPaidSubAffiliateCommission", "currentStillOwedSubAffiliateCommission", "totalSubAffiliateCommissionBasedOnOverallClearErcFees", "potentialFutureStillOwedSubAffiliateCommission", "mikesRelatedCommissionPercentage", "amountDueToMikeBasedOnAmountRefunded", "totalMikesCommissionDueBasedOnFeesAlreadyPaid", "currentPaidMikesCommission", "currentStillOwedMikesCommission", "totalMikesCommissionBasedOnOverallClearErcFees", "potentialFutureStillOwedMikesAffiliateCommission", "jacobsRelatedCommissionPercentage", "amountDueToJacobBasedOnAmountRefunded", "totalJacobsCommissionDueBasedOnFeesAlreadyPaid", "currentPaidJacobsCommission", "currentStillOwedJacobsCommission", "totalJacobsCommissionBasedOnOverallClearErcFees", "potentialFutureStillOwedJacobsAffiliateCommission", "tomsRelatedCommissionPercentage", "amountDueToTomBasedOnAmountRefunded", "totalTomsCommissionDueBasedOnFeesAlreadyPaid", "currentPaidTomsCommission", "currentStillOwedTomsCommission", "totalTomsCommissionBasedOnOverallClearErcFees", "potentialFutureStillOwedTomsAffiliateCommission", "totalCommissionDue", "totalPaidCommission", "totalCurrentStillOwedCommission", "totalCommissionBasedOnOverallClearErcFees", "totalPotentialFutureStillOwedAffiliateCommission", "totalCommissionPercentage", "cpaOnFile", "totalCpaCosts", "cpaCostsPaid", "cpaCostsStillOwed", "totalTaxAttorneyCosts", "taxAttorneyCostsPaid", "taxAttorneyCostsOwed", "totalOtherCosts", "otherCostsPaid", "otherCostsStillOwed", "totalCommissionsAndCosts", "netRevenueWithQ3", "netRevenueAsAPercentageOfFeesWithQ3", "netRevenueWithoutQ3", "netRevenueAsAPercentageOfFeesWithoutQ3", "isThereAContract", "isThereAClawbackContract", "wasThereARequestForMoneyBack", "doesTheFileHaveASubstantiationPackage", "estimatedFutureCostToSubstantiateFile", "affiliateRefundLiabilityForAmountAlreadyPaid", "cpaFutureMaintenanceAndAppealCosts", "taxAttorneyProjectedCosts", "estimatedFlatRateToFixAFile", "estimatedPastInHouseCosts", "estimatedFutureInhouseCostsAt_40kPerMonthFor_5yrs", "isBadDeal", "linkToFolder", "folderHref" ], "example": "id" }, "uniqueItems": true } ], "title": "Deals.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DefaultSources.Filter": { "type": "object", "title": "DefaultSources.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "name" ], "example": "description" }, "uniqueItems": true } ], "title": "DefaultSources.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DefaultSources.Filter1": { "type": "object", "title": "DefaultSources.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "DefaultSources.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "name" ], "example": "description" }, "uniqueItems": true } ], "title": "DefaultSources.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DefaultUser.Filter": { "type": "object", "title": "DefaultUser.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" }, "processFlowGroup": { "type": "boolean" }, "roleGroup": { "type": "boolean" }, "source": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "name", "processFlowGroup", "roleGroup", "source" ], "example": "description" }, "uniqueItems": true } ], "title": "DefaultUser.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DefaultUser.Filter1": { "type": "object", "title": "DefaultUser.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "DefaultUser.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" }, "processFlowGroup": { "type": "boolean" }, "roleGroup": { "type": "boolean" }, "source": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "name", "processFlowGroup", "roleGroup", "source" ], "example": "description" }, "uniqueItems": true } ], "title": "DefaultUser.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DocumentCategory.Filter": { "type": "object", "title": "DocumentCategory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "sortOrder": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "sortOrder" ], "example": "id" }, "uniqueItems": true } ], "title": "DocumentCategory.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DocumentCategory.Filter1": { "type": "object", "title": "DocumentCategory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "DocumentCategory.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "sortOrder": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "sortOrder" ], "example": "id" }, "uniqueItems": true } ], "title": "DocumentCategory.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DocumentSend.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "DocumentSend.ScopeFilter" }, "DocumentSend.IncludeFilter.Items": { "title": "DocumentSend.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "company", "sentByUser" ] }, "scope": { "$ref": "#/components/schemas/DocumentSend.ScopeFilter" } } }, "DocumentSend.Filter": { "type": "object", "title": "DocumentSend.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "DocumentSend.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "documentType": { "type": "boolean" }, "sentToEmail": { "type": "boolean" }, "sentAt": { "type": "boolean" }, "status": { "type": "boolean" }, "receivedAt": { "type": "boolean" }, "receivedByUserId": { "type": "boolean" }, "viewedAt": { "type": "boolean" }, "signedAt": { "type": "boolean" }, "signedContractId": { "type": "boolean" }, "ccEmails": { "type": "boolean" }, "notes": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "deletedAt": { "type": "boolean" }, "deletedById": { "type": "boolean" }, "companyId": { "type": "boolean" }, "sentByUserId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "documentType", "sentToEmail", "sentAt", "status", "receivedAt", "receivedByUserId", "viewedAt", "signedAt", "signedContractId", "ccEmails", "notes", "createdAt", "updatedAt", "deletedAt", "deletedById", "companyId", "sentByUserId" ], "example": "id" }, "uniqueItems": true } ], "title": "DocumentSend.Fields" }, "include": { "title": "DocumentSend.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/DocumentSend.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DocumentType.Filter": { "type": "object", "title": "DocumentType.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "docTypeId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "docTypeId" ], "example": "id" }, "uniqueItems": true } ], "title": "DocumentType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DocumentType.Filter1": { "type": "object", "title": "DocumentType.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "DocumentType.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "docTypeId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "docTypeId" ], "example": "id" }, "uniqueItems": true } ], "title": "DocumentType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Document.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Document.ScopeFilter" }, "Document.IncludeFilter.Items": { "title": "Document.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "fileUpload", "thumbnailFileUpload", "documentCategory", "addedByUser" ] }, "scope": { "$ref": "#/components/schemas/Document.ScopeFilter" } } }, "Document.Filter": { "type": "object", "title": "Document.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Document.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "title": { "type": "boolean" }, "description": { "type": "boolean" }, "dateAdded": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "fileUploadId": { "type": "boolean" }, "thumbnailFileUploadId": { "type": "boolean" }, "documentCategoryId": { "type": "boolean" }, "addedByUserId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "title", "description", "dateAdded", "isArchived", "fileUploadId", "thumbnailFileUploadId", "documentCategoryId", "addedByUserId" ], "example": "id" }, "uniqueItems": true } ], "title": "Document.Fields" }, "include": { "title": "Document.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Document.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "EmailComposeRewriteRequest": { "type": "object", "required": [ "draft", "tone" ], "properties": { "draft": { "type": "string" }, "tone": { "type": "string", "enum": [ "formal", "informal" ] }, "subject": { "type": "string" } }, "title": "EmailComposeRewriteRequest" }, "UpdateEmailTemplate": { "type": "object", "properties": { "name": { "type": "string" }, "subject": { "type": "string", "nullable": true }, "bodyHtml": { "type": "string" }, "bodyText": { "type": "string", "nullable": true }, "salesMaterialIds": { "type": "array", "items": { "type": "number" } }, "audience": { "type": "string", "enum": [ "internal", "employer", "both" ] }, "companyId": { "type": "number", "nullable": true }, "calEventTypeKey": { "type": "string", "nullable": true } }, "title": "UpdateEmailTemplate" }, "NewEmailTemplate": { "type": "object", "required": [ "name", "bodyHtml" ], "properties": { "name": { "type": "string" }, "subject": { "type": "string", "nullable": true }, "bodyHtml": { "type": "string" }, "bodyText": { "type": "string", "nullable": true }, "salesMaterialIds": { "type": "array", "items": { "type": "number" } }, "audience": { "type": "string", "enum": [ "internal", "employer", "both" ] }, "companyId": { "type": "number", "nullable": true }, "calEventTypeKey": { "type": "string", "nullable": true } }, "title": "NewEmailTemplate" }, "EmployeeActivityEvent.Filter": { "type": "object", "title": "EmployeeActivityEvent.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "EmployeeActivityEvent.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "clearErcUserId": { "type": "boolean" }, "companyId": { "type": "boolean" }, "enrollmentSpanId": { "type": "boolean" }, "eventType": { "type": "boolean" }, "source": { "type": "boolean" }, "sourceRef": { "type": "boolean" }, "occurredAt": { "type": "boolean" }, "recordedAt": { "type": "boolean" }, "payloadJson": { "type": "boolean" }, "dedupeKey": { "type": "boolean" }, "phiTier": { "type": "boolean" }, "supersedesEventId": { "type": "boolean" }, "createdAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "clearErcUserId", "companyId", "enrollmentSpanId", "eventType", "source", "sourceRef", "occurredAt", "recordedAt", "payloadJson", "dedupeKey", "phiTier", "supersedesEventId", "createdAt" ], "example": "id" }, "uniqueItems": true } ], "title": "EmployeeActivityEvent.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "EmployeeChangeEvent.Filter": { "type": "object", "title": "EmployeeChangeEvent.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "eventDate": { "type": "boolean" }, "changedBy": { "type": "boolean" }, "isChangeOfEnrolled": { "type": "boolean" }, "companyId": { "type": "boolean" }, "oldNumber": { "type": "boolean" }, "newNumber": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "eventDate", "changedBy", "isChangeOfEnrolled", "companyId", "oldNumber", "newNumber" ], "example": "id" }, "uniqueItems": true } ], "title": "EmployeeChangeEvent.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "EmployeeChangeEvent.Filter1": { "type": "object", "title": "EmployeeChangeEvent.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "EmployeeChangeEvent.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "eventDate": { "type": "boolean" }, "changedBy": { "type": "boolean" }, "isChangeOfEnrolled": { "type": "boolean" }, "companyId": { "type": "boolean" }, "oldNumber": { "type": "boolean" }, "newNumber": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "eventDate", "changedBy", "isChangeOfEnrolled", "companyId", "oldNumber", "newNumber" ], "example": "id" }, "uniqueItems": true } ], "title": "EmployeeChangeEvent.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "FieldRuleGroups.Filter": { "type": "object", "title": "FieldRuleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "businessRuleGroupId": { "type": "boolean" }, "fieldName": { "type": "boolean" }, "id": { "type": "boolean" }, "processFlowGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "businessRuleGroupId", "fieldName", "id", "processFlowGroupId" ], "example": "businessRuleGroupId" }, "uniqueItems": true } ], "title": "FieldRuleGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "FieldRuleGroups.Filter1": { "type": "object", "title": "FieldRuleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "FieldRuleGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "businessRuleGroupId": { "type": "boolean" }, "fieldName": { "type": "boolean" }, "id": { "type": "boolean" }, "processFlowGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "businessRuleGroupId", "fieldName", "id", "processFlowGroupId" ], "example": "businessRuleGroupId" }, "uniqueItems": true } ], "title": "FieldRuleGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "FileUploads.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "FileUploads.ScopeFilter" }, "FileUploads.IncludeFilter.Items": { "title": "FileUploads.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "uploadedByUser", "documentType", "company", "processflowProgress", "payment" ] }, "scope": { "$ref": "#/components/schemas/FileUploads.ScopeFilter" } } }, "FileUploads.Filter": { "type": "object", "title": "FileUploads.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "dateUploaded": { "type": "boolean" }, "originalFilename": { "type": "boolean" }, "filename": { "type": "boolean" }, "key": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "encoding": { "type": "boolean" }, "mimetype": { "type": "boolean" }, "size": { "type": "boolean" }, "uploaded_by": { "type": "boolean" }, "notes": { "type": "boolean" }, "lastUpdated": { "type": "boolean" }, "tpaInvoice": { "type": "boolean" }, "documentTypeId": { "type": "boolean" }, "companyId": { "type": "boolean" }, "processflowProgressId": { "type": "boolean" }, "paymentId": { "type": "boolean" }, "boardTaskId": { "type": "boolean" }, "boardInline": { "type": "boolean" }, "educationInline": { "type": "boolean" }, "asanaAttachmentGid": { "type": "boolean" }, "asanaWritebackError": { "type": "boolean" }, "asanaWritebackErrorAt": { "type": "boolean" }, "asanaWritebackAbandonedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "dateUploaded", "originalFilename", "filename", "key", "isArchived", "encoding", "mimetype", "size", "uploaded_by", "notes", "lastUpdated", "tpaInvoice", "documentTypeId", "companyId", "processflowProgressId", "paymentId", "boardTaskId", "boardInline", "educationInline", "asanaAttachmentGid", "asanaWritebackError", "asanaWritebackErrorAt", "asanaWritebackAbandonedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "FileUploads.Fields" }, "include": { "title": "FileUploads.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/FileUploads.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "FileUploads.Filter1": { "type": "object", "title": "FileUploads.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "FileUploads.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "dateUploaded": { "type": "boolean" }, "originalFilename": { "type": "boolean" }, "filename": { "type": "boolean" }, "key": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "encoding": { "type": "boolean" }, "mimetype": { "type": "boolean" }, "size": { "type": "boolean" }, "uploaded_by": { "type": "boolean" }, "notes": { "type": "boolean" }, "lastUpdated": { "type": "boolean" }, "tpaInvoice": { "type": "boolean" }, "documentTypeId": { "type": "boolean" }, "companyId": { "type": "boolean" }, "processflowProgressId": { "type": "boolean" }, "paymentId": { "type": "boolean" }, "boardTaskId": { "type": "boolean" }, "boardInline": { "type": "boolean" }, "educationInline": { "type": "boolean" }, "asanaAttachmentGid": { "type": "boolean" }, "asanaWritebackError": { "type": "boolean" }, "asanaWritebackErrorAt": { "type": "boolean" }, "asanaWritebackAbandonedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "dateUploaded", "originalFilename", "filename", "key", "isArchived", "encoding", "mimetype", "size", "uploaded_by", "notes", "lastUpdated", "tpaInvoice", "documentTypeId", "companyId", "processflowProgressId", "paymentId", "boardTaskId", "boardInline", "educationInline", "asanaAttachmentGid", "asanaWritebackError", "asanaWritebackErrorAt", "asanaWritebackAbandonedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "FileUploads.Fields" }, "include": { "title": "FileUploads.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/FileUploads.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "HelpAskRequest": { "type": "object", "required": [ "question" ], "properties": { "question": { "type": "string" }, "previewRole": { "type": "string" }, "history": { "type": "array", "items": { "type": "object", "required": [ "role", "content" ], "properties": { "role": { "type": "string", "enum": [ "user", "assistant" ] }, "content": { "type": "string" } } } } }, "title": "HelpAskRequest" }, "Industries.Filter": { "type": "object", "title": "Industries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "Industries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Industries.Filter1": { "type": "object", "title": "Industries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Industries.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "Industries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "IndustryGroupMembers.Filter": { "type": "object", "title": "IndustryGroupMembers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "industry": { "type": "boolean" }, "industryGroup": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "industry", "industryGroup" ], "example": "id" }, "uniqueItems": true } ], "title": "IndustryGroupMembers.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "IndustryGroupMembers.Filter1": { "type": "object", "title": "IndustryGroupMembers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "IndustryGroupMembers.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "industry": { "type": "boolean" }, "industryGroup": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "industry", "industryGroup" ], "example": "id" }, "uniqueItems": true } ], "title": "IndustryGroupMembers.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "IndustryGroups.Filter": { "type": "object", "title": "IndustryGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description" ], "example": "id" }, "uniqueItems": true } ], "title": "IndustryGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "IndustryGroups.Filter1": { "type": "object", "title": "IndustryGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "IndustryGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description" ], "example": "id" }, "uniqueItems": true } ], "title": "IndustryGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "InteractionTypes.Filter": { "type": "object", "title": "InteractionTypes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "customerViewable": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "customerViewable", "id", "name" ], "example": "customerViewable" }, "uniqueItems": true } ], "title": "InteractionTypes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "InteractionTypes.Filter1": { "type": "object", "title": "InteractionTypes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "InteractionTypes.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "customerViewable": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "customerViewable", "id", "name" ], "example": "customerViewable" }, "uniqueItems": true } ], "title": "InteractionTypes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "NewInteractionHandover": { "type": "object", "required": [ "assigneeUserId", "returnToOwner" ], "properties": { "assigneeUserId": { "type": "string" }, "returnToOwner": { "type": "boolean" }, "note": { "type": "string", "nullable": true, "maxLength": 500 } }, "title": "NewInteractionHandover" }, "Interactions.Filter": { "type": "object", "title": "Interactions.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "activity": { "type": "boolean" }, "companyId": { "type": "boolean" }, "dateCreated": { "type": "boolean" }, "followupDatetime": { "type": "boolean" }, "followupReminderLeadMinutes": { "type": "boolean" }, "aiSummary": { "type": "boolean" }, "aiSummaryHash": { "type": "boolean" }, "aiSummaryAt": { "type": "boolean" }, "aiSummaryError": { "type": "boolean" }, "aiSummaryAttempts": { "type": "boolean" }, "id": { "type": "boolean" }, "interactionFrom": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "interactionRegarding": { "type": "boolean" }, "interactionTo": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "needsFollowUp": { "type": "boolean" }, "read": { "type": "boolean" }, "summary": { "type": "boolean" }, "type": { "type": "boolean" }, "visibleByAffiliate": { "type": "boolean" }, "visibleByCpa": { "type": "boolean" }, "deleted": { "type": "boolean" }, "visibleByPaymaster": { "type": "boolean" }, "visibleBySuperUser": { "type": "boolean" }, "visibleByTaxAttorney": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "activity", "companyId", "dateCreated", "followupDatetime", "followupReminderLeadMinutes", "aiSummary", "aiSummaryHash", "aiSummaryAt", "aiSummaryError", "aiSummaryAttempts", "id", "interactionFrom", "deletedBy", "interactionRegarding", "interactionTo", "isInternal", "needsFollowUp", "read", "summary", "type", "visibleByAffiliate", "visibleByCpa", "deleted", "visibleByPaymaster", "visibleBySuperUser", "visibleByTaxAttorney" ], "example": "activity" }, "uniqueItems": true } ], "title": "Interactions.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Interactions.Filter1": { "type": "object", "title": "Interactions.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Interactions.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "activity": { "type": "boolean" }, "companyId": { "type": "boolean" }, "dateCreated": { "type": "boolean" }, "followupDatetime": { "type": "boolean" }, "followupReminderLeadMinutes": { "type": "boolean" }, "aiSummary": { "type": "boolean" }, "aiSummaryHash": { "type": "boolean" }, "aiSummaryAt": { "type": "boolean" }, "aiSummaryError": { "type": "boolean" }, "aiSummaryAttempts": { "type": "boolean" }, "id": { "type": "boolean" }, "interactionFrom": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "interactionRegarding": { "type": "boolean" }, "interactionTo": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "needsFollowUp": { "type": "boolean" }, "read": { "type": "boolean" }, "summary": { "type": "boolean" }, "type": { "type": "boolean" }, "visibleByAffiliate": { "type": "boolean" }, "visibleByCpa": { "type": "boolean" }, "deleted": { "type": "boolean" }, "visibleByPaymaster": { "type": "boolean" }, "visibleBySuperUser": { "type": "boolean" }, "visibleByTaxAttorney": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "activity", "companyId", "dateCreated", "followupDatetime", "followupReminderLeadMinutes", "aiSummary", "aiSummaryHash", "aiSummaryAt", "aiSummaryError", "aiSummaryAttempts", "id", "interactionFrom", "deletedBy", "interactionRegarding", "interactionTo", "isInternal", "needsFollowUp", "read", "summary", "type", "visibleByAffiliate", "visibleByCpa", "deleted", "visibleByPaymaster", "visibleBySuperUser", "visibleByTaxAttorney" ], "example": "activity" }, "uniqueItems": true } ], "title": "Interactions.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Log.Filter": { "type": "object", "title": "Log.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "body": { "type": "boolean" }, "eventTimestamp": { "type": "boolean" }, "executionTime": { "type": "boolean" }, "id": { "type": "boolean" }, "remoteIp": { "type": "boolean" }, "url": { "type": "boolean" }, "userId": { "type": "boolean" }, "entity": { "type": "boolean" }, "entityId": { "type": "boolean" }, "action": { "type": "boolean" }, "interceptorExtraDetails": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "body", "eventTimestamp", "executionTime", "id", "remoteIp", "url", "userId", "entity", "entityId", "action", "interceptorExtraDetails" ], "example": "body" }, "uniqueItems": true } ], "title": "Log.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Log.Filter1": { "type": "object", "title": "Log.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Log.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "body": { "type": "boolean" }, "eventTimestamp": { "type": "boolean" }, "executionTime": { "type": "boolean" }, "id": { "type": "boolean" }, "remoteIp": { "type": "boolean" }, "url": { "type": "boolean" }, "userId": { "type": "boolean" }, "entity": { "type": "boolean" }, "entityId": { "type": "boolean" }, "action": { "type": "boolean" }, "interceptorExtraDetails": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "body", "eventTimestamp", "executionTime", "id", "remoteIp", "url", "userId", "entity", "entityId", "action", "interceptorExtraDetails" ], "example": "body" }, "uniqueItems": true } ], "title": "Log.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MagicLink.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "MagicLink.ScopeFilter" }, "MagicLink.IncludeFilter.Items": { "title": "MagicLink.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "createdByUser" ] }, "scope": { "$ref": "#/components/schemas/MagicLink.ScopeFilter" } } }, "MagicLink.Filter": { "type": "object", "title": "MagicLink.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "createdById": { "type": "boolean" }, "usedAt": { "type": "boolean" }, "type": { "type": "boolean" }, "data": { "type": "boolean" }, "options": { "type": "boolean" }, "code": { "type": "boolean" }, "name": { "type": "boolean" }, "email": { "type": "boolean" }, "dobAttempts": { "type": "boolean" }, "dobVerifiedAt": { "type": "boolean" }, "invalidatedAt": { "type": "boolean" }, "expiresAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "createdById", "usedAt", "type", "data", "options", "code", "name", "email", "dobAttempts", "dobVerifiedAt", "invalidatedAt", "expiresAt" ], "example": "id" }, "uniqueItems": true } ], "title": "MagicLink.Fields" }, "include": { "title": "MagicLink.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MagicLink.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MagicLink.Filter1": { "type": "object", "title": "MagicLink.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MagicLink.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "createdById": { "type": "boolean" }, "usedAt": { "type": "boolean" }, "type": { "type": "boolean" }, "data": { "type": "boolean" }, "options": { "type": "boolean" }, "code": { "type": "boolean" }, "name": { "type": "boolean" }, "email": { "type": "boolean" }, "dobAttempts": { "type": "boolean" }, "dobVerifiedAt": { "type": "boolean" }, "invalidatedAt": { "type": "boolean" }, "expiresAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "createdById", "usedAt", "type", "data", "options", "code", "name", "email", "dobAttempts", "dobVerifiedAt", "invalidatedAt", "expiresAt" ], "example": "id" }, "uniqueItems": true } ], "title": "MagicLink.Fields" }, "include": { "title": "MagicLink.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MagicLink.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateBinds.Filter": { "type": "object", "title": "MandateBinds.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "binds": { "type": "boolean" }, "boundBy": { "type": "boolean" }, "id": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "binds", "boundBy", "id" ], "example": "binds" }, "uniqueItems": true } ], "title": "MandateBinds.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateBinds.Filter1": { "type": "object", "title": "MandateBinds.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateBinds.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "binds": { "type": "boolean" }, "boundBy": { "type": "boolean" }, "id": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "binds", "boundBy", "id" ], "example": "binds" }, "uniqueItems": true } ], "title": "MandateBinds.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateEffectGroupEntries.Filter": { "type": "object", "title": "MandateEffectGroupEntries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "mandateEffectGroup": { "type": "boolean" }, "mandateEffect": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "mandateEffectGroup", "mandateEffect" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateEffectGroupEntries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateEffectGroupEntries.Filter1": { "type": "object", "title": "MandateEffectGroupEntries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateEffectGroupEntries.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "mandateEffectGroup": { "type": "boolean" }, "mandateEffect": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "mandateEffectGroup", "mandateEffect" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateEffectGroupEntries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateEffectGroups.Filter": { "type": "object", "title": "MandateEffectGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateEffectGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateEffectGroups.Filter1": { "type": "object", "title": "MandateEffectGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateEffectGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateEffectGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateEffectIndustry.Filter": { "type": "object", "title": "MandateEffectIndustry.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "effect": { "type": "boolean" }, "industry": { "type": "boolean" }, "causesRevReduction": { "type": "boolean" }, "isApproved": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "effectedHoursOfOperation": { "type": "boolean" }, "potentialRevenueLost": { "type": "boolean" }, "effectTitle": { "type": "boolean" }, "createdBy": { "type": "boolean" }, "effectDescription": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "effect", "industry", "causesRevReduction", "isApproved", "isPublic", "effectedHoursOfOperation", "potentialRevenueLost", "effectTitle", "createdBy", "effectDescription" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateEffectIndustry.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateEffectIndustry.Filter1": { "type": "object", "title": "MandateEffectIndustry.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateEffectIndustry.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "effect": { "type": "boolean" }, "industry": { "type": "boolean" }, "causesRevReduction": { "type": "boolean" }, "isApproved": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "effectedHoursOfOperation": { "type": "boolean" }, "potentialRevenueLost": { "type": "boolean" }, "effectTitle": { "type": "boolean" }, "createdBy": { "type": "boolean" }, "effectDescription": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "effect", "industry", "causesRevReduction", "isApproved", "isPublic", "effectedHoursOfOperation", "potentialRevenueLost", "effectTitle", "createdBy", "effectDescription" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateEffectIndustry.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateEffectIndustryGroup.Filter": { "type": "object", "title": "MandateEffectIndustryGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "effect": { "type": "boolean" }, "industryGroup": { "type": "boolean" }, "causesRevReduction": { "type": "boolean" }, "effectedHoursOfOperation": { "type": "boolean" }, "potentialRevenueLost": { "type": "boolean" }, "isApproved": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "createdBy": { "type": "boolean" }, "effectTitle": { "type": "boolean" }, "effectDescription": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "effect", "industryGroup", "causesRevReduction", "effectedHoursOfOperation", "potentialRevenueLost", "isApproved", "isPublic", "createdBy", "effectTitle", "effectDescription" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateEffectIndustryGroup.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateEffectIndustryGroup.Filter1": { "type": "object", "title": "MandateEffectIndustryGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateEffectIndustryGroup.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "effect": { "type": "boolean" }, "industryGroup": { "type": "boolean" }, "causesRevReduction": { "type": "boolean" }, "effectedHoursOfOperation": { "type": "boolean" }, "potentialRevenueLost": { "type": "boolean" }, "isApproved": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "createdBy": { "type": "boolean" }, "effectTitle": { "type": "boolean" }, "effectDescription": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "effect", "industryGroup", "causesRevReduction", "effectedHoursOfOperation", "potentialRevenueLost", "isApproved", "isPublic", "createdBy", "effectTitle", "effectDescription" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateEffectIndustryGroup.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateEffects.Filter": { "type": "object", "title": "MandateEffects.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "alternativeTerms": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description", "alternativeTerms", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateEffects.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateEffects.Filter1": { "type": "object", "title": "MandateEffects.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateEffects.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "alternativeTerms": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description", "alternativeTerms", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateEffects.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateIndustries.Filter": { "type": "object", "title": "MandateIndustries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "industry": { "type": "boolean" }, "mandate": { "type": "boolean" }, "effect": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "industry", "mandate", "effect" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateIndustries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateIndustries.Filter1": { "type": "object", "title": "MandateIndustries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateIndustries.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "industry": { "type": "boolean" }, "mandate": { "type": "boolean" }, "effect": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "industry", "mandate", "effect" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateIndustries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateIndustryGroups.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "MandateIndustryGroups.ScopeFilter" }, "MandateIndustryGroups.IncludeFilter.Items": { "title": "MandateIndustryGroups.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "mandate", "mandateMandateEffect" ] }, "scope": { "$ref": "#/components/schemas/MandateIndustryGroups.ScopeFilter" } } }, "MandateIndustryGroups.Filter": { "type": "object", "title": "MandateIndustryGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "reason": { "type": "boolean" }, "mandateId": { "type": "boolean" }, "mandateMandateEffectId": { "type": "boolean" }, "industryGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "reason", "mandateId", "mandateMandateEffectId", "industryGroupId" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateIndustryGroups.Fields" }, "include": { "title": "MandateIndustryGroups.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandateIndustryGroups.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateIndustryGroups.Filter1": { "type": "object", "title": "MandateIndustryGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateIndustryGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "reason": { "type": "boolean" }, "mandateId": { "type": "boolean" }, "mandateMandateEffectId": { "type": "boolean" }, "industryGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "reason", "mandateId", "mandateMandateEffectId", "industryGroupId" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateIndustryGroups.Fields" }, "include": { "title": "MandateIndustryGroups.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandateIndustryGroups.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateMandateEffect.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "MandateMandateEffect.ScopeFilter" }, "MandateMandateEffect.IncludeFilter.Items": { "title": "MandateMandateEffect.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "mandate", "createdByUser", "feedbackByUser", "mandateEffect" ] }, "scope": { "$ref": "#/components/schemas/MandateMandateEffect.ScopeFilter" } } }, "MandateMandateEffect.Filter": { "type": "object", "title": "MandateMandateEffect.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "mandateId": { "type": "boolean" }, "createdByUserId": { "type": "boolean" }, "feedbackByUserId": { "type": "boolean" }, "mandateEffectId": { "type": "boolean" }, "confidence": { "type": "boolean" }, "description": { "type": "boolean" }, "aiDescription": { "type": "boolean" }, "humanDescription": { "type": "boolean" }, "impact": { "type": "boolean" }, "aiImpact": { "type": "boolean" }, "humanImpact": { "type": "boolean" }, "incorrectReason": { "type": "boolean" }, "references": { "type": "boolean" }, "aiReferences": { "type": "boolean" }, "humanReferences": { "type": "boolean" }, "createdBy": { "type": "boolean" }, "doesActuallyApply": { "type": "boolean" }, "archivedAt": { "type": "boolean" }, "reasonArchived": { "type": "boolean" }, "notes": { "type": "boolean" }, "aiVersion": { "type": "boolean" }, "aiIterationNumber": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "mandateId", "createdByUserId", "feedbackByUserId", "mandateEffectId", "confidence", "description", "aiDescription", "humanDescription", "impact", "aiImpact", "humanImpact", "incorrectReason", "references", "aiReferences", "humanReferences", "createdBy", "doesActuallyApply", "archivedAt", "reasonArchived", "notes", "aiVersion", "aiIterationNumber" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateMandateEffect.Fields" }, "include": { "title": "MandateMandateEffect.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandateMandateEffect.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateMandateEffect.Filter1": { "type": "object", "title": "MandateMandateEffect.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateMandateEffect.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "mandateId": { "type": "boolean" }, "createdByUserId": { "type": "boolean" }, "feedbackByUserId": { "type": "boolean" }, "mandateEffectId": { "type": "boolean" }, "confidence": { "type": "boolean" }, "description": { "type": "boolean" }, "aiDescription": { "type": "boolean" }, "humanDescription": { "type": "boolean" }, "impact": { "type": "boolean" }, "aiImpact": { "type": "boolean" }, "humanImpact": { "type": "boolean" }, "incorrectReason": { "type": "boolean" }, "references": { "type": "boolean" }, "aiReferences": { "type": "boolean" }, "humanReferences": { "type": "boolean" }, "createdBy": { "type": "boolean" }, "doesActuallyApply": { "type": "boolean" }, "archivedAt": { "type": "boolean" }, "reasonArchived": { "type": "boolean" }, "notes": { "type": "boolean" }, "aiVersion": { "type": "boolean" }, "aiIterationNumber": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "mandateId", "createdByUserId", "feedbackByUserId", "mandateEffectId", "confidence", "description", "aiDescription", "humanDescription", "impact", "aiImpact", "humanImpact", "incorrectReason", "references", "aiReferences", "humanReferences", "createdBy", "doesActuallyApply", "archivedAt", "reasonArchived", "notes", "aiVersion", "aiIterationNumber" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateMandateEffect.Fields" }, "include": { "title": "MandateMandateEffect.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandateMandateEffect.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateParagraphIndustries.Filter": { "type": "object", "title": "MandateParagraphIndustries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "industry": { "type": "boolean" }, "mandate": { "type": "boolean" }, "paragraph": { "type": "boolean" }, "effect": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "industry", "mandate", "paragraph", "effect" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateParagraphIndustries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateParagraphIndustries.Filter1": { "type": "object", "title": "MandateParagraphIndustries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateParagraphIndustries.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "industry": { "type": "boolean" }, "mandate": { "type": "boolean" }, "paragraph": { "type": "boolean" }, "effect": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "industry", "mandate", "paragraph", "effect" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateParagraphIndustries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateParagraphIndustryGroups.Filter": { "type": "object", "title": "MandateParagraphIndustryGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "industryGroup": { "type": "boolean" }, "mandate": { "type": "boolean" }, "paragraph": { "type": "boolean" }, "effect": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "industryGroup", "mandate", "paragraph", "effect" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateParagraphIndustryGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateParagraphIndustryGroups.Filter1": { "type": "object", "title": "MandateParagraphIndustryGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateParagraphIndustryGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "industryGroup": { "type": "boolean" }, "mandate": { "type": "boolean" }, "paragraph": { "type": "boolean" }, "effect": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "industryGroup", "mandate", "paragraph", "effect" ], "example": "id" }, "uniqueItems": true } ], "title": "MandateParagraphIndustryGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateTypes.Filter": { "type": "object", "title": "MandateTypes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "legallyBinding": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "legallyBinding", "name" ], "example": "description" }, "uniqueItems": true } ], "title": "MandateTypes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MandateTypes.Filter1": { "type": "object", "title": "MandateTypes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MandateTypes.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "legallyBinding": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "legallyBinding", "name" ], "example": "description" }, "uniqueItems": true } ], "title": "MandateTypes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Mandates.Filter": { "type": "object", "title": "Mandates.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "aiName": { "type": "boolean" }, "aiNameFeedbackSubmittedAt": { "type": "boolean" }, "isAiNameCorrect": { "type": "boolean" }, "aiNameAtFeedbackTime": { "type": "boolean" }, "googleSheetName": { "type": "boolean" }, "humanName": { "type": "boolean" }, "name": { "type": "boolean" }, "nameNotes": { "type": "boolean" }, "feedbackOnNameUserId": { "type": "boolean" }, "aiEffectiveDate": { "type": "boolean" }, "aiEffectiveDateFeedbackSubmittedAt": { "type": "boolean" }, "isAiEffectiveDateCorrect": { "type": "boolean" }, "aiEffectiveDateAtFeedbackTime": { "type": "boolean" }, "googleSheetDate": { "type": "boolean" }, "humanEffectiveDate": { "type": "boolean" }, "effectiveDate": { "type": "boolean" }, "effectiveDateNotes": { "type": "boolean" }, "feedbackOnEffectiveDateUserId": { "type": "boolean" }, "aiUntilDate": { "type": "boolean" }, "aiUntilDateFeedbackSubmittedAt": { "type": "boolean" }, "isAiUntilDateCorrect": { "type": "boolean" }, "aiUntilDateAtFeedbackTime": { "type": "boolean" }, "humanUntilDate": { "type": "boolean" }, "untilDate": { "type": "boolean" }, "untilDateNotes": { "type": "boolean" }, "feedbackOnUntilDateUserId": { "type": "boolean" }, "googleSheetUrl": { "type": "boolean" }, "humanUrl": { "type": "boolean" }, "url": { "type": "boolean" }, "aiAuthority": { "type": "boolean" }, "aiAuthorityFeedbackSubmittedAt": { "type": "boolean" }, "isAiAuthorityCorrect": { "type": "boolean" }, "aiAuthorityAtFeedbackTime": { "type": "boolean" }, "googleSheetAuthority": { "type": "boolean" }, "humanAuthority": { "type": "boolean" }, "authority": { "type": "boolean" }, "authorityNotes": { "type": "boolean" }, "feedbackOnAuthorityUserId": { "type": "boolean" }, "aiIssueDate": { "type": "boolean" }, "humanIssueDate": { "type": "boolean" }, "issueDate": { "type": "boolean" }, "googleSheetArea": { "type": "boolean" }, "aiState": { "type": "boolean" }, "aiStateFeedbackSubmittedAt": { "type": "boolean" }, "isAiStateCorrect": { "type": "boolean" }, "aiStateAtFeedbackTime": { "type": "boolean" }, "googleSheetState": { "type": "boolean" }, "humanState": { "type": "boolean" }, "state": { "type": "boolean" }, "stateNotes": { "type": "boolean" }, "feedbackOnStateUserId": { "type": "boolean" }, "processedByAiAt": { "type": "boolean" }, "aiVersion": { "type": "boolean" }, "aiIterationNumber": { "type": "boolean" }, "needsAiSync": { "type": "boolean" }, "status": { "type": "boolean" }, "error": { "type": "boolean" }, "counties": { "type": "boolean" }, "aiCounties": { "type": "boolean" }, "aiCountiesFeedbackSubmittedAt": { "type": "boolean" }, "isAiCountiesCorrect": { "type": "boolean" }, "aiCountiesAtFeedbackTime": { "type": "boolean" }, "googleSheetCounties": { "type": "boolean" }, "humanCounties": { "type": "boolean" }, "countiesNotes": { "type": "boolean" }, "feedbackOnCountiesUserId": { "type": "boolean" }, "cities": { "type": "boolean" }, "aiCities": { "type": "boolean" }, "aiCitiesFeedbackSubmittedAt": { "type": "boolean" }, "isAiCitiesCorrect": { "type": "boolean" }, "aiCitiesAtFeedbackTime": { "type": "boolean" }, "googleSheetCities": { "type": "boolean" }, "humanCities": { "type": "boolean" }, "citiesNotes": { "type": "boolean" }, "feedbackOnCitiesUserId": { "type": "boolean" }, "aiExtendedUntilDate": { "type": "boolean" }, "aiExtendedUntilDateFeedbackSubmittedAt": { "type": "boolean" }, "isAiExtendedUntilDateCorrect": { "type": "boolean" }, "aiExtendedUntilDateAtFeedbackTime": { "type": "boolean" }, "humanExtendedUntilDate": { "type": "boolean" }, "extendedUntilDate": { "type": "boolean" }, "extendedUntilDateNotes": { "type": "boolean" }, "feedbackOnExtendedUntilDateUserId": { "type": "boolean" }, "summary": { "type": "boolean" }, "notes": { "type": "boolean" }, "mandateType": { "type": "boolean" }, "fileId": { "type": "boolean" }, "orderId": { "type": "boolean" }, "orderText": { "type": "boolean" }, "key": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "aiName", "aiNameFeedbackSubmittedAt", "isAiNameCorrect", "aiNameAtFeedbackTime", "googleSheetName", "humanName", "name", "nameNotes", "feedbackOnNameUserId", "aiEffectiveDate", "aiEffectiveDateFeedbackSubmittedAt", "isAiEffectiveDateCorrect", "aiEffectiveDateAtFeedbackTime", "googleSheetDate", "humanEffectiveDate", "effectiveDate", "effectiveDateNotes", "feedbackOnEffectiveDateUserId", "aiUntilDate", "aiUntilDateFeedbackSubmittedAt", "isAiUntilDateCorrect", "aiUntilDateAtFeedbackTime", "humanUntilDate", "untilDate", "untilDateNotes", "feedbackOnUntilDateUserId", "googleSheetUrl", "humanUrl", "url", "aiAuthority", "aiAuthorityFeedbackSubmittedAt", "isAiAuthorityCorrect", "aiAuthorityAtFeedbackTime", "googleSheetAuthority", "humanAuthority", "authority", "authorityNotes", "feedbackOnAuthorityUserId", "aiIssueDate", "humanIssueDate", "issueDate", "googleSheetArea", "aiState", "aiStateFeedbackSubmittedAt", "isAiStateCorrect", "aiStateAtFeedbackTime", "googleSheetState", "humanState", "state", "stateNotes", "feedbackOnStateUserId", "processedByAiAt", "aiVersion", "aiIterationNumber", "needsAiSync", "status", "error", "counties", "aiCounties", "aiCountiesFeedbackSubmittedAt", "isAiCountiesCorrect", "aiCountiesAtFeedbackTime", "googleSheetCounties", "humanCounties", "countiesNotes", "feedbackOnCountiesUserId", "cities", "aiCities", "aiCitiesFeedbackSubmittedAt", "isAiCitiesCorrect", "aiCitiesAtFeedbackTime", "googleSheetCities", "humanCities", "citiesNotes", "feedbackOnCitiesUserId", "aiExtendedUntilDate", "aiExtendedUntilDateFeedbackSubmittedAt", "isAiExtendedUntilDateCorrect", "aiExtendedUntilDateAtFeedbackTime", "humanExtendedUntilDate", "extendedUntilDate", "extendedUntilDateNotes", "feedbackOnExtendedUntilDateUserId", "summary", "notes", "mandateType", "fileId", "orderId", "orderText", "key" ], "example": "id" }, "uniqueItems": true } ], "title": "Mandates.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Mandates.Filter1": { "type": "object", "title": "Mandates.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Mandates.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "aiName": { "type": "boolean" }, "aiNameFeedbackSubmittedAt": { "type": "boolean" }, "isAiNameCorrect": { "type": "boolean" }, "aiNameAtFeedbackTime": { "type": "boolean" }, "googleSheetName": { "type": "boolean" }, "humanName": { "type": "boolean" }, "name": { "type": "boolean" }, "nameNotes": { "type": "boolean" }, "feedbackOnNameUserId": { "type": "boolean" }, "aiEffectiveDate": { "type": "boolean" }, "aiEffectiveDateFeedbackSubmittedAt": { "type": "boolean" }, "isAiEffectiveDateCorrect": { "type": "boolean" }, "aiEffectiveDateAtFeedbackTime": { "type": "boolean" }, "googleSheetDate": { "type": "boolean" }, "humanEffectiveDate": { "type": "boolean" }, "effectiveDate": { "type": "boolean" }, "effectiveDateNotes": { "type": "boolean" }, "feedbackOnEffectiveDateUserId": { "type": "boolean" }, "aiUntilDate": { "type": "boolean" }, "aiUntilDateFeedbackSubmittedAt": { "type": "boolean" }, "isAiUntilDateCorrect": { "type": "boolean" }, "aiUntilDateAtFeedbackTime": { "type": "boolean" }, "humanUntilDate": { "type": "boolean" }, "untilDate": { "type": "boolean" }, "untilDateNotes": { "type": "boolean" }, "feedbackOnUntilDateUserId": { "type": "boolean" }, "googleSheetUrl": { "type": "boolean" }, "humanUrl": { "type": "boolean" }, "url": { "type": "boolean" }, "aiAuthority": { "type": "boolean" }, "aiAuthorityFeedbackSubmittedAt": { "type": "boolean" }, "isAiAuthorityCorrect": { "type": "boolean" }, "aiAuthorityAtFeedbackTime": { "type": "boolean" }, "googleSheetAuthority": { "type": "boolean" }, "humanAuthority": { "type": "boolean" }, "authority": { "type": "boolean" }, "authorityNotes": { "type": "boolean" }, "feedbackOnAuthorityUserId": { "type": "boolean" }, "aiIssueDate": { "type": "boolean" }, "humanIssueDate": { "type": "boolean" }, "issueDate": { "type": "boolean" }, "googleSheetArea": { "type": "boolean" }, "aiState": { "type": "boolean" }, "aiStateFeedbackSubmittedAt": { "type": "boolean" }, "isAiStateCorrect": { "type": "boolean" }, "aiStateAtFeedbackTime": { "type": "boolean" }, "googleSheetState": { "type": "boolean" }, "humanState": { "type": "boolean" }, "state": { "type": "boolean" }, "stateNotes": { "type": "boolean" }, "feedbackOnStateUserId": { "type": "boolean" }, "processedByAiAt": { "type": "boolean" }, "aiVersion": { "type": "boolean" }, "aiIterationNumber": { "type": "boolean" }, "needsAiSync": { "type": "boolean" }, "status": { "type": "boolean" }, "error": { "type": "boolean" }, "counties": { "type": "boolean" }, "aiCounties": { "type": "boolean" }, "aiCountiesFeedbackSubmittedAt": { "type": "boolean" }, "isAiCountiesCorrect": { "type": "boolean" }, "aiCountiesAtFeedbackTime": { "type": "boolean" }, "googleSheetCounties": { "type": "boolean" }, "humanCounties": { "type": "boolean" }, "countiesNotes": { "type": "boolean" }, "feedbackOnCountiesUserId": { "type": "boolean" }, "cities": { "type": "boolean" }, "aiCities": { "type": "boolean" }, "aiCitiesFeedbackSubmittedAt": { "type": "boolean" }, "isAiCitiesCorrect": { "type": "boolean" }, "aiCitiesAtFeedbackTime": { "type": "boolean" }, "googleSheetCities": { "type": "boolean" }, "humanCities": { "type": "boolean" }, "citiesNotes": { "type": "boolean" }, "feedbackOnCitiesUserId": { "type": "boolean" }, "aiExtendedUntilDate": { "type": "boolean" }, "aiExtendedUntilDateFeedbackSubmittedAt": { "type": "boolean" }, "isAiExtendedUntilDateCorrect": { "type": "boolean" }, "aiExtendedUntilDateAtFeedbackTime": { "type": "boolean" }, "humanExtendedUntilDate": { "type": "boolean" }, "extendedUntilDate": { "type": "boolean" }, "extendedUntilDateNotes": { "type": "boolean" }, "feedbackOnExtendedUntilDateUserId": { "type": "boolean" }, "summary": { "type": "boolean" }, "notes": { "type": "boolean" }, "mandateType": { "type": "boolean" }, "fileId": { "type": "boolean" }, "orderId": { "type": "boolean" }, "orderText": { "type": "boolean" }, "key": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "aiName", "aiNameFeedbackSubmittedAt", "isAiNameCorrect", "aiNameAtFeedbackTime", "googleSheetName", "humanName", "name", "nameNotes", "feedbackOnNameUserId", "aiEffectiveDate", "aiEffectiveDateFeedbackSubmittedAt", "isAiEffectiveDateCorrect", "aiEffectiveDateAtFeedbackTime", "googleSheetDate", "humanEffectiveDate", "effectiveDate", "effectiveDateNotes", "feedbackOnEffectiveDateUserId", "aiUntilDate", "aiUntilDateFeedbackSubmittedAt", "isAiUntilDateCorrect", "aiUntilDateAtFeedbackTime", "humanUntilDate", "untilDate", "untilDateNotes", "feedbackOnUntilDateUserId", "googleSheetUrl", "humanUrl", "url", "aiAuthority", "aiAuthorityFeedbackSubmittedAt", "isAiAuthorityCorrect", "aiAuthorityAtFeedbackTime", "googleSheetAuthority", "humanAuthority", "authority", "authorityNotes", "feedbackOnAuthorityUserId", "aiIssueDate", "humanIssueDate", "issueDate", "googleSheetArea", "aiState", "aiStateFeedbackSubmittedAt", "isAiStateCorrect", "aiStateAtFeedbackTime", "googleSheetState", "humanState", "state", "stateNotes", "feedbackOnStateUserId", "processedByAiAt", "aiVersion", "aiIterationNumber", "needsAiSync", "status", "error", "counties", "aiCounties", "aiCountiesFeedbackSubmittedAt", "isAiCountiesCorrect", "aiCountiesAtFeedbackTime", "googleSheetCounties", "humanCounties", "countiesNotes", "feedbackOnCountiesUserId", "cities", "aiCities", "aiCitiesFeedbackSubmittedAt", "isAiCitiesCorrect", "aiCitiesAtFeedbackTime", "googleSheetCities", "humanCities", "citiesNotes", "feedbackOnCitiesUserId", "aiExtendedUntilDate", "aiExtendedUntilDateFeedbackSubmittedAt", "isAiExtendedUntilDateCorrect", "aiExtendedUntilDateAtFeedbackTime", "humanExtendedUntilDate", "extendedUntilDate", "extendedUntilDateNotes", "feedbackOnExtendedUntilDateUserId", "summary", "notes", "mandateType", "fileId", "orderId", "orderText", "key" ], "example": "id" }, "uniqueItems": true } ], "title": "Mandates.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PushTokenSave": { "type": "object", "required": [ "token", "deviceId" ], "properties": { "token": { "type": "string", "minLength": 1, "maxLength": 4096 }, "deviceId": { "type": "string", "minLength": 1, "maxLength": 255 }, "platform": { "type": "string", "enum": [ "ios", "android" ] } }, "title": "PushTokenSave" }, "MondaySyncData.Filter": { "type": "object", "title": "MondaySyncData.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "clearErcId": { "type": "boolean" }, "ercData": { "type": "boolean" }, "ercLastUpdated": { "type": "boolean" }, "fieldId": { "type": "boolean" }, "id": { "type": "boolean" }, "mondayData": { "type": "boolean" }, "mondayId": { "type": "boolean" }, "mondayLastUpdated": { "type": "boolean" }, "processed": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "clearErcId", "ercData", "ercLastUpdated", "fieldId", "id", "mondayData", "mondayId", "mondayLastUpdated", "processed" ], "example": "clearErcId" }, "uniqueItems": true } ], "title": "MondaySyncData.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "MondaySyncData.Filter1": { "type": "object", "title": "MondaySyncData.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "MondaySyncData.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "clearErcId": { "type": "boolean" }, "ercData": { "type": "boolean" }, "ercLastUpdated": { "type": "boolean" }, "fieldId": { "type": "boolean" }, "id": { "type": "boolean" }, "mondayData": { "type": "boolean" }, "mondayId": { "type": "boolean" }, "mondayLastUpdated": { "type": "boolean" }, "processed": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "clearErcId", "ercData", "ercLastUpdated", "fieldId", "id", "mondayData", "mondayId", "mondayLastUpdated", "processed" ], "example": "clearErcId" }, "uniqueItems": true } ], "title": "MondaySyncData.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Multitenant.Filter": { "type": "object", "title": "Multitenant.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "url": { "type": "boolean" }, "logo": { "type": "boolean" }, "name": { "type": "boolean" }, "smallLogo": { "type": "boolean" }, "emailLogoUrl": { "type": "boolean" }, "emailLogoDarkUrl": { "type": "boolean" }, "emailSource": { "type": "boolean" }, "dashboardBaseUrl": { "type": "boolean" }, "postalAddress": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "url", "logo", "name", "smallLogo", "emailLogoUrl", "emailLogoDarkUrl", "emailSource", "dashboardBaseUrl", "postalAddress" ], "example": "id" }, "uniqueItems": true } ], "title": "Multitenant.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Multitenant.Filter1": { "type": "object", "title": "Multitenant.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Multitenant.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "url": { "type": "boolean" }, "logo": { "type": "boolean" }, "name": { "type": "boolean" }, "smallLogo": { "type": "boolean" }, "emailLogoUrl": { "type": "boolean" }, "emailLogoDarkUrl": { "type": "boolean" }, "emailSource": { "type": "boolean" }, "dashboardBaseUrl": { "type": "boolean" }, "postalAddress": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "url", "logo", "name", "smallLogo", "emailLogoUrl", "emailLogoDarkUrl", "emailSource", "dashboardBaseUrl", "postalAddress" ], "example": "id" }, "uniqueItems": true } ], "title": "Multitenant.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "My IP Response": { "type": "object", "title": "My IP Response", "properties": { "ip": { "type": "string" } } }, "User.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "User.ScopeFilter" }, "User.IncludeFilter.Items": { "title": "User.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "userCredentials" ] }, "scope": { "$ref": "#/components/schemas/User.ScopeFilter" } } }, "User.Filter": { "type": "object", "title": "User.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "User.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "realm": { "type": "boolean" }, "username": { "type": "boolean" }, "email": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "verificationToken": { "type": "boolean" } }, "additionalProperties": true }, { "type": "array", "items": { "type": "string", "example": "id" }, "uniqueItems": true } ], "title": "User.Fields" }, "include": { "title": "User.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/User.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Navigation.Filter": { "type": "object", "title": "Navigation.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "icon": { "type": "boolean" }, "href": { "type": "boolean" }, "current": { "type": "boolean" }, "requiredRoles": { "type": "boolean" }, "requiresOneRole": { "type": "boolean" }, "order": { "type": "boolean" }, "visible": { "type": "boolean" }, "parentId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "icon", "href", "current", "requiredRoles", "requiresOneRole", "order", "visible", "parentId" ], "example": "id" }, "uniqueItems": true } ], "title": "Navigation.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Navigation.Filter1": { "type": "object", "title": "Navigation.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Navigation.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "icon": { "type": "boolean" }, "href": { "type": "boolean" }, "current": { "type": "boolean" }, "requiredRoles": { "type": "boolean" }, "requiresOneRole": { "type": "boolean" }, "order": { "type": "boolean" }, "visible": { "type": "boolean" }, "parentId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "icon", "href", "current", "requiredRoles", "requiresOneRole", "order", "visible", "parentId" ], "example": "id" }, "uniqueItems": true } ], "title": "Navigation.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Notification.Filter": { "type": "object", "title": "Notification.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "from": { "type": "boolean" }, "type": { "type": "boolean" }, "to": { "type": "boolean" }, "uniqueUrl": { "type": "boolean" }, "status": { "type": "boolean" }, "subject": { "type": "boolean" }, "body": { "type": "boolean" }, "templateId": { "type": "boolean" }, "provider": { "type": "boolean" }, "providerId": { "type": "boolean" }, "error": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "from", "type", "to", "uniqueUrl", "status", "subject", "body", "templateId", "provider", "providerId", "error" ], "example": "id" }, "uniqueItems": true } ], "title": "Notification.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Notification.Filter1": { "type": "object", "title": "Notification.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Notification.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "from": { "type": "boolean" }, "type": { "type": "boolean" }, "to": { "type": "boolean" }, "uniqueUrl": { "type": "boolean" }, "status": { "type": "boolean" }, "subject": { "type": "boolean" }, "body": { "type": "boolean" }, "templateId": { "type": "boolean" }, "provider": { "type": "boolean" }, "providerId": { "type": "boolean" }, "error": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "from", "type", "to", "uniqueUrl", "status", "subject", "body", "templateId", "provider", "providerId", "error" ], "example": "id" }, "uniqueItems": true } ], "title": "Notification.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "OcrCensusExtractRequest": { "type": "object", "required": [ "fileName", "contentBase64" ], "properties": { "fileName": { "type": "string" }, "contentBase64": { "type": "string" } }, "title": "OcrCensusExtractRequest" }, "Files.Filter": { "type": "object", "title": "Files.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "orderid": { "type": "boolean" }, "tpaInvoice": { "type": "boolean" }, "externalurl": { "type": "boolean" }, "internalurl": { "type": "boolean" }, "createddate": { "type": "boolean" }, "lastupdated": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "orderid", "tpaInvoice", "externalurl", "internalurl", "createddate", "lastupdated" ], "example": "id" }, "uniqueItems": true } ], "title": "Files.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Orders.Filter": { "type": "object", "title": "Orders.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "idenNum": { "type": "boolean" }, "geoType": { "type": "boolean" }, "name": { "type": "boolean" }, "orderNum": { "type": "boolean" }, "broadstreetNum": { "type": "boolean" }, "govBody": { "type": "boolean" }, "amend": { "type": "boolean" }, "startD": { "type": "boolean" }, "endD": { "type": "boolean" }, "initialEmgcy": { "type": "boolean" }, "contEmgcy": { "type": "boolean" }, "reopen": { "type": "boolean" }, "stayHome": { "type": "boolean" }, "curfew": { "type": "boolean" }, "maskReq": { "type": "boolean" }, "gatherBan": { "type": "boolean" }, "socialDist": { "type": "boolean" }, "bsns": { "type": "boolean" }, "restaurant": { "type": "boolean" }, "school": { "type": "boolean" }, "medProc": { "type": "boolean" }, "travel": { "type": "boolean" }, "correcFac": { "type": "boolean" }, "vaccine": { "type": "boolean" }, "notes": { "type": "boolean" }, "industries": { "type": "boolean" }, "lastupdated": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "idenNum", "geoType", "name", "orderNum", "broadstreetNum", "govBody", "amend", "startD", "endD", "initialEmgcy", "contEmgcy", "reopen", "stayHome", "curfew", "maskReq", "gatherBan", "socialDist", "bsns", "restaurant", "school", "medProc", "travel", "correcFac", "vaccine", "notes", "industries", "lastupdated" ], "example": "id" }, "uniqueItems": true } ], "title": "Orders.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Orders.Filter1": { "type": "object", "title": "Orders.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Orders.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "idenNum": { "type": "boolean" }, "geoType": { "type": "boolean" }, "name": { "type": "boolean" }, "orderNum": { "type": "boolean" }, "broadstreetNum": { "type": "boolean" }, "govBody": { "type": "boolean" }, "amend": { "type": "boolean" }, "startD": { "type": "boolean" }, "endD": { "type": "boolean" }, "initialEmgcy": { "type": "boolean" }, "contEmgcy": { "type": "boolean" }, "reopen": { "type": "boolean" }, "stayHome": { "type": "boolean" }, "curfew": { "type": "boolean" }, "maskReq": { "type": "boolean" }, "gatherBan": { "type": "boolean" }, "socialDist": { "type": "boolean" }, "bsns": { "type": "boolean" }, "restaurant": { "type": "boolean" }, "school": { "type": "boolean" }, "medProc": { "type": "boolean" }, "travel": { "type": "boolean" }, "correcFac": { "type": "boolean" }, "vaccine": { "type": "boolean" }, "notes": { "type": "boolean" }, "industries": { "type": "boolean" }, "lastupdated": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "idenNum", "geoType", "name", "orderNum", "broadstreetNum", "govBody", "amend", "startD", "endD", "initialEmgcy", "contEmgcy", "reopen", "stayHome", "curfew", "maskReq", "gatherBan", "socialDist", "bsns", "restaurant", "school", "medProc", "travel", "correcFac", "vaccine", "notes", "industries", "lastupdated" ], "example": "id" }, "uniqueItems": true } ], "title": "Orders.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "AddOutboundTaskDelegate": { "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string" } }, "title": "AddOutboundTaskDelegate" }, "UpdateOutboundTaskStatus": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "pending", "notified", "viewed", "completed", "cancelled" ] }, "override": { "type": "boolean" } }, "title": "UpdateOutboundTaskStatus" }, "UpdateOutboundTask": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "assigneeUserId": { "type": "string", "nullable": true }, "dueAt": { "type": "string", "nullable": true }, "channelEmail": { "type": "boolean" } }, "title": "UpdateOutboundTask" }, "NewOutboundTask": { "type": "object", "required": [ "companyId", "title" ], "properties": { "companyId": { "type": "number" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "assigneeUserId": { "type": "string", "nullable": true }, "dueAt": { "type": "string", "nullable": true }, "channelEmail": { "type": "boolean" } }, "title": "NewOutboundTask" }, "OutboundTask.Filter": { "type": "object", "title": "OutboundTask.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "OutboundTask.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "assigneeUserId": { "type": "boolean" }, "title": { "type": "boolean" }, "description": { "type": "boolean" }, "dueAt": { "type": "boolean" }, "status": { "type": "boolean" }, "completedAt": { "type": "boolean" }, "completedVia": { "type": "boolean" }, "createdByUserId": { "type": "boolean" }, "lastNudgedAt": { "type": "boolean" }, "nudgeCount": { "type": "boolean" }, "channelEmail": { "type": "boolean" }, "interactionId": { "type": "boolean" }, "sweepKey": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "sourceType": { "type": "boolean" }, "sourceRuleId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "assigneeUserId", "title", "description", "dueAt", "status", "completedAt", "completedVia", "createdByUserId", "lastNudgedAt", "nudgeCount", "channelEmail", "interactionId", "sweepKey", "createdAt", "updatedAt", "sourceType", "sourceRuleId" ], "example": "id" }, "uniqueItems": true } ], "title": "OutboundTask.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PackageSectionRules.Filter": { "type": "object", "title": "PackageSectionRules.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "isEnabler": { "type": "boolean" }, "helpDoc": { "type": "boolean" }, "processflow": { "type": "boolean" }, "processflowGroup": { "type": "boolean" }, "fieldName": { "type": "boolean" }, "fieldValue": { "type": "boolean" }, "title": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "isEnabler", "helpDoc", "processflow", "processflowGroup", "fieldName", "fieldValue", "title" ], "example": "id" }, "uniqueItems": true } ], "title": "PackageSectionRules.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PackageSectionRules.Filter1": { "type": "object", "title": "PackageSectionRules.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "PackageSectionRules.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "isEnabler": { "type": "boolean" }, "helpDoc": { "type": "boolean" }, "processflow": { "type": "boolean" }, "processflowGroup": { "type": "boolean" }, "fieldName": { "type": "boolean" }, "fieldValue": { "type": "boolean" }, "title": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "isEnabler", "helpDoc", "processflow", "processflowGroup", "fieldName", "fieldValue", "title" ], "example": "id" }, "uniqueItems": true } ], "title": "PackageSectionRules.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PaymentIntents.Filter": { "type": "object", "title": "PaymentIntents.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "details": { "type": "boolean" }, "company": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "details", "company" ], "example": "id" }, "uniqueItems": true } ], "title": "PaymentIntents.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PaymentIntents.Filter1": { "type": "object", "title": "PaymentIntents.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "PaymentIntents.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "details": { "type": "boolean" }, "company": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "details", "company" ], "example": "id" }, "uniqueItems": true } ], "title": "PaymentIntents.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Payment.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Payment.ScopeFilter" }, "Payment.IncludeFilter.Items": { "title": "Payment.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "createdByUser", "company", "toCompany", "fromCompany", "toUser", "fromUser", "paymentRequest", "lineItem", "invoice", "forCompany", "sentByUser", "confirmedByUser", "reconciledByUser", "voidedByUser", "reversalOfPayment" ] }, "scope": { "$ref": "#/components/schemas/Payment.ScopeFilter" } } }, "Payment.Filter": { "type": "object", "title": "Payment.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "transactionId": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "createdById": { "type": "boolean" }, "companyId": { "type": "boolean" }, "date": { "type": "boolean" }, "amount": { "type": "boolean" }, "toCompanyId": { "type": "boolean" }, "fromCompanyId": { "type": "boolean" }, "toUserId": { "type": "boolean" }, "to": { "type": "boolean" }, "fromUserId": { "type": "boolean" }, "from": { "type": "boolean" }, "toClearErc": { "type": "boolean" }, "fromClearErc": { "type": "boolean" }, "reference": { "type": "boolean" }, "notes": { "type": "boolean" }, "description": { "type": "boolean" }, "paymentRequestId": { "type": "boolean" }, "lineItemId": { "type": "boolean" }, "invoiceId": { "type": "boolean" }, "stripeChargeId": { "type": "boolean" }, "qbPaymentId": { "type": "boolean" }, "type": { "type": "boolean" }, "quarter": { "type": "boolean" }, "receivedByPaymasterAt": { "type": "boolean" }, "chequeNumber": { "type": "boolean" }, "interest": { "type": "boolean" }, "taxes": { "type": "boolean" }, "forCompanyId": { "type": "boolean" }, "wireFee": { "type": "boolean" }, "currency": { "type": "boolean" }, "method": { "type": "boolean" }, "status": { "type": "boolean" }, "initiatedAt": { "type": "boolean" }, "confirmedAt": { "type": "boolean" }, "sentById": { "type": "boolean" }, "confirmedById": { "type": "boolean" }, "wireTraceNumber": { "type": "boolean" }, "wireMemo": { "type": "boolean" }, "reconciled": { "type": "boolean" }, "reconciledById": { "type": "boolean" }, "reconciledAt": { "type": "boolean" }, "externalRef": { "type": "boolean" }, "voidedAt": { "type": "boolean" }, "voidedById": { "type": "boolean" }, "reversalOfPaymentId": { "type": "boolean" }, "batchId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "transactionId", "createdAt", "updatedAt", "createdById", "companyId", "date", "amount", "toCompanyId", "fromCompanyId", "toUserId", "to", "fromUserId", "from", "toClearErc", "fromClearErc", "reference", "notes", "description", "paymentRequestId", "lineItemId", "invoiceId", "stripeChargeId", "qbPaymentId", "type", "quarter", "receivedByPaymasterAt", "chequeNumber", "interest", "taxes", "forCompanyId", "wireFee", "currency", "method", "status", "initiatedAt", "confirmedAt", "sentById", "confirmedById", "wireTraceNumber", "wireMemo", "reconciled", "reconciledById", "reconciledAt", "externalRef", "voidedAt", "voidedById", "reversalOfPaymentId", "batchId" ], "example": "id" }, "uniqueItems": true } ], "title": "Payment.Fields" }, "include": { "title": "Payment.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Payment.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Payment.Filter1": { "type": "object", "title": "Payment.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Payment.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "transactionId": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "createdById": { "type": "boolean" }, "companyId": { "type": "boolean" }, "date": { "type": "boolean" }, "amount": { "type": "boolean" }, "toCompanyId": { "type": "boolean" }, "fromCompanyId": { "type": "boolean" }, "toUserId": { "type": "boolean" }, "to": { "type": "boolean" }, "fromUserId": { "type": "boolean" }, "from": { "type": "boolean" }, "toClearErc": { "type": "boolean" }, "fromClearErc": { "type": "boolean" }, "reference": { "type": "boolean" }, "notes": { "type": "boolean" }, "description": { "type": "boolean" }, "paymentRequestId": { "type": "boolean" }, "lineItemId": { "type": "boolean" }, "invoiceId": { "type": "boolean" }, "stripeChargeId": { "type": "boolean" }, "qbPaymentId": { "type": "boolean" }, "type": { "type": "boolean" }, "quarter": { "type": "boolean" }, "receivedByPaymasterAt": { "type": "boolean" }, "chequeNumber": { "type": "boolean" }, "interest": { "type": "boolean" }, "taxes": { "type": "boolean" }, "forCompanyId": { "type": "boolean" }, "wireFee": { "type": "boolean" }, "currency": { "type": "boolean" }, "method": { "type": "boolean" }, "status": { "type": "boolean" }, "initiatedAt": { "type": "boolean" }, "confirmedAt": { "type": "boolean" }, "sentById": { "type": "boolean" }, "confirmedById": { "type": "boolean" }, "wireTraceNumber": { "type": "boolean" }, "wireMemo": { "type": "boolean" }, "reconciled": { "type": "boolean" }, "reconciledById": { "type": "boolean" }, "reconciledAt": { "type": "boolean" }, "externalRef": { "type": "boolean" }, "voidedAt": { "type": "boolean" }, "voidedById": { "type": "boolean" }, "reversalOfPaymentId": { "type": "boolean" }, "batchId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "transactionId", "createdAt", "updatedAt", "createdById", "companyId", "date", "amount", "toCompanyId", "fromCompanyId", "toUserId", "to", "fromUserId", "from", "toClearErc", "fromClearErc", "reference", "notes", "description", "paymentRequestId", "lineItemId", "invoiceId", "stripeChargeId", "qbPaymentId", "type", "quarter", "receivedByPaymasterAt", "chequeNumber", "interest", "taxes", "forCompanyId", "wireFee", "currency", "method", "status", "initiatedAt", "confirmedAt", "sentById", "confirmedById", "wireTraceNumber", "wireMemo", "reconciled", "reconciledById", "reconciledAt", "externalRef", "voidedAt", "voidedById", "reversalOfPaymentId", "batchId" ], "example": "id" }, "uniqueItems": true } ], "title": "Payment.Fields" }, "include": { "title": "Payment.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Payment.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PaymentNew.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "PaymentNew.ScopeFilter" }, "PaymentNew.IncludeFilter.Items": { "title": "PaymentNew.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "sourceCompany", "destinationCompany" ] }, "scope": { "$ref": "#/components/schemas/PaymentNew.ScopeFilter" } } }, "PaymentNew.Filter": { "type": "object", "title": "PaymentNew.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "PaymentNew.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "createdById": { "type": "boolean" }, "sourceCompanyId": { "type": "boolean" }, "destinationCompanyId": { "type": "boolean" }, "sourceUserId": { "type": "boolean" }, "destinationUserId": { "type": "boolean" }, "amount": { "type": "boolean" }, "feeAmount": { "type": "boolean" }, "currency": { "type": "boolean" }, "method": { "type": "boolean" }, "status": { "type": "boolean" }, "initiatedAt": { "type": "boolean" }, "sentAt": { "type": "boolean" }, "sentById": { "type": "boolean" }, "confirmedAt": { "type": "boolean" }, "confirmedById": { "type": "boolean" }, "returnedAt": { "type": "boolean" }, "returnedById": { "type": "boolean" }, "voidedAt": { "type": "boolean" }, "voidedById": { "type": "boolean" }, "traceNumber": { "type": "boolean" }, "processorRef": { "type": "boolean" }, "memo": { "type": "boolean" }, "notes": { "type": "boolean" }, "reference": { "type": "boolean" }, "batchId": { "type": "boolean" }, "externalRef": { "type": "boolean" }, "reversalOfPaymentId": { "type": "boolean" }, "chequeNumber": { "type": "boolean" }, "legacySource": { "type": "boolean" }, "legacyId": { "type": "boolean" }, "importBatchId": { "type": "boolean" }, "sourceSnapshot": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "createdById", "sourceCompanyId", "destinationCompanyId", "sourceUserId", "destinationUserId", "amount", "feeAmount", "currency", "method", "status", "initiatedAt", "sentAt", "sentById", "confirmedAt", "confirmedById", "returnedAt", "returnedById", "voidedAt", "voidedById", "traceNumber", "processorRef", "memo", "notes", "reference", "batchId", "externalRef", "reversalOfPaymentId", "chequeNumber", "legacySource", "legacyId", "importBatchId", "sourceSnapshot" ], "example": "id" }, "uniqueItems": true } ], "title": "PaymentNew.Fields" }, "include": { "title": "PaymentNew.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/PaymentNew.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PayoutPaperworkOverride.Filter": { "type": "object", "title": "PayoutPaperworkOverride.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "transactionId": { "type": "boolean" }, "companyId": { "type": "boolean" }, "userId": { "type": "boolean" }, "reason": { "type": "boolean" }, "createdAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "transactionId", "companyId", "userId", "reason", "createdAt" ], "example": "id" }, "uniqueItems": true } ], "title": "PayoutPaperworkOverride.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PayoutPaperworkOverride.Filter1": { "type": "object", "title": "PayoutPaperworkOverride.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "PayoutPaperworkOverride.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "transactionId": { "type": "boolean" }, "companyId": { "type": "boolean" }, "userId": { "type": "boolean" }, "reason": { "type": "boolean" }, "createdAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "transactionId", "companyId", "userId", "reason", "createdAt" ], "example": "id" }, "uniqueItems": true } ], "title": "PayoutPaperworkOverride.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PayrollContact.Filter": { "type": "object", "title": "PayrollContact.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "phone": { "type": "boolean" }, "email": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "phone", "email" ], "example": "id" }, "uniqueItems": true } ], "title": "PayrollContact.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PayrollContact.Filter1": { "type": "object", "title": "PayrollContact.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "PayrollContact.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "phone": { "type": "boolean" }, "email": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "phone", "email" ], "example": "id" }, "uniqueItems": true } ], "title": "PayrollContact.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PingResponse": { "type": "object", "title": "PingResponse", "properties": { "greeting": { "type": "string" }, "date": { "type": "string" }, "url": { "type": "string" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } }, "additionalProperties": true } } }, "ProcessflowGroupRoleGroups.Filter": { "type": "object", "title": "ProcessflowGroupRoleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "processflowGroupId": { "type": "boolean" }, "roleGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "processflowGroupId", "roleGroupId" ], "example": "id" }, "uniqueItems": true } ], "title": "ProcessflowGroupRoleGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowGroupRoleGroups.Filter1": { "type": "object", "title": "ProcessflowGroupRoleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ProcessflowGroupRoleGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "processflowGroupId": { "type": "boolean" }, "roleGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "processflowGroupId", "roleGroupId" ], "example": "id" }, "uniqueItems": true } ], "title": "ProcessflowGroupRoleGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowGroup.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "ProcessflowGroup.ScopeFilter" }, "ProcessflowGroup.IncludeFilter.Items": { "title": "ProcessflowGroup.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "roles", "roleGroups", "processflows" ] }, "scope": { "$ref": "#/components/schemas/ProcessflowGroup.ScopeFilter" } } }, "ProcessflowGroup.Filter": { "type": "object", "title": "ProcessflowGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description" ], "example": "id" }, "uniqueItems": true } ], "title": "ProcessflowGroup.Fields" }, "include": { "title": "ProcessflowGroup.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ProcessflowGroup.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowGroup.Filter1": { "type": "object", "title": "ProcessflowGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ProcessflowGroup.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description" ], "example": "id" }, "uniqueItems": true } ], "title": "ProcessflowGroup.Fields" }, "include": { "title": "ProcessflowGroup.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ProcessflowGroup.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowProgress.Filter": { "type": "object", "title": "ProcessflowProgress.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "client": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "companyId": { "type": "boolean" }, "currentStage": { "type": "boolean" }, "currentStep": { "type": "boolean" }, "data": { "type": "boolean" }, "group": { "type": "boolean" }, "id": { "type": "boolean" }, "status": { "type": "boolean" }, "city": { "type": "boolean" }, "state": { "type": "boolean" }, "country": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "client", "createdAt", "updatedAt", "companyId", "currentStage", "currentStep", "data", "group", "id", "status", "city", "state", "country", "userId" ], "example": "client" }, "uniqueItems": true } ], "title": "ProcessflowProgress.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowProgress.Filter1": { "type": "object", "title": "ProcessflowProgress.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ProcessflowProgress.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "client": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "companyId": { "type": "boolean" }, "currentStage": { "type": "boolean" }, "currentStep": { "type": "boolean" }, "data": { "type": "boolean" }, "group": { "type": "boolean" }, "id": { "type": "boolean" }, "status": { "type": "boolean" }, "city": { "type": "boolean" }, "state": { "type": "boolean" }, "country": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "client", "createdAt", "updatedAt", "companyId", "currentStage", "currentStep", "data", "group", "id", "status", "city", "state", "country", "userId" ], "example": "client" }, "uniqueItems": true } ], "title": "ProcessflowProgress.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowRuleGroups.Filter": { "type": "object", "title": "ProcessflowRuleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "businessRuleGroupId": { "type": "boolean" }, "id": { "type": "boolean" }, "processflowId": { "type": "boolean" }, "ruleGroupsAreOr": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "businessRuleGroupId", "id", "processflowId", "ruleGroupsAreOr" ], "example": "businessRuleGroupId" }, "uniqueItems": true } ], "title": "ProcessflowRuleGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowRuleGroups.Filter1": { "type": "object", "title": "ProcessflowRuleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ProcessflowRuleGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "businessRuleGroupId": { "type": "boolean" }, "id": { "type": "boolean" }, "processflowId": { "type": "boolean" }, "ruleGroupsAreOr": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "businessRuleGroupId", "id", "processflowId", "ruleGroupsAreOr" ], "example": "businessRuleGroupId" }, "uniqueItems": true } ], "title": "ProcessflowRuleGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowStageRuleGroups.Filter": { "type": "object", "title": "ProcessflowStageRuleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "businessRuleGroupId": { "type": "boolean" }, "stageId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "businessRuleGroupId", "stageId" ], "example": "id" }, "uniqueItems": true } ], "title": "ProcessflowStageRuleGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowStageRuleGroups.Filter1": { "type": "object", "title": "ProcessflowStageRuleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ProcessflowStageRuleGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "businessRuleGroupId": { "type": "boolean" }, "stageId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "businessRuleGroupId", "stageId" ], "example": "id" }, "uniqueItems": true } ], "title": "ProcessflowStageRuleGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowStages.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "ProcessflowStages.ScopeFilter" }, "ProcessflowStages.IncludeFilter.Items": { "title": "ProcessflowStages.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "businessRuleGroups" ] }, "scope": { "$ref": "#/components/schemas/ProcessflowStages.ScopeFilter" } } }, "ProcessflowStages.Filter": { "type": "object", "title": "ProcessflowStages.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "ruleGroupsAreOr": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "order": { "type": "boolean" }, "group": { "type": "boolean" }, "isPublic": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "ruleGroupsAreOr", "name", "description", "order", "group", "isPublic" ], "example": "id" }, "uniqueItems": true } ], "title": "ProcessflowStages.Fields" }, "include": { "title": "ProcessflowStages.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ProcessflowStages.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ProcessflowStages.Filter1": { "type": "object", "title": "ProcessflowStages.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ProcessflowStages.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "ruleGroupsAreOr": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "order": { "type": "boolean" }, "group": { "type": "boolean" }, "isPublic": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "ruleGroupsAreOr", "name", "description", "order", "group", "isPublic" ], "example": "id" }, "uniqueItems": true } ], "title": "ProcessflowStages.Fields" }, "include": { "title": "ProcessflowStages.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ProcessflowStages.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Processflow.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Processflow.ScopeFilter" }, "Processflow.IncludeFilter.Items": { "title": "Processflow.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "businessRuleGroups" ] }, "scope": { "$ref": "#/components/schemas/Processflow.ScopeFilter" } } }, "Processflow.Filter": { "type": "object", "title": "Processflow.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "group": { "type": "boolean" }, "title": { "type": "boolean" }, "details": { "type": "boolean" }, "order": { "type": "boolean" }, "reliesOnTrue": { "type": "boolean" }, "reliesOnFalse": { "type": "boolean" }, "inputType": { "type": "boolean" }, "checkboxEntries": { "type": "boolean" }, "fileUploadEntries": { "type": "boolean" }, "stateEntries": { "type": "boolean" }, "yesNoEntries": { "type": "boolean" }, "selectBoxEntries": { "type": "boolean" }, "entries": { "type": "boolean" }, "datePickerEntries": { "type": "boolean" }, "textareaEntries": { "type": "boolean" }, "optional": { "type": "boolean" }, "internalOnly": { "type": "boolean" }, "sendsEmailOnCompletion": { "type": "boolean" }, "causesRepContactOnCompletion": { "type": "boolean" }, "ruleGroupsAreOr": { "type": "boolean" }, "stage": { "type": "boolean" }, "internalComments": { "type": "boolean" }, "textfieldName": { "type": "boolean" }, "helpDoc": { "type": "boolean" }, "checkboxEnabler": { "type": "boolean" }, "textfieldEntries": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "group", "title", "details", "order", "reliesOnTrue", "reliesOnFalse", "inputType", "checkboxEntries", "fileUploadEntries", "stateEntries", "yesNoEntries", "selectBoxEntries", "entries", "datePickerEntries", "textareaEntries", "optional", "internalOnly", "sendsEmailOnCompletion", "causesRepContactOnCompletion", "ruleGroupsAreOr", "stage", "internalComments", "textfieldName", "helpDoc", "checkboxEnabler", "textfieldEntries" ], "example": "id" }, "uniqueItems": true } ], "title": "Processflow.Fields" }, "include": { "title": "Processflow.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Processflow.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Processflow.Filter1": { "type": "object", "title": "Processflow.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Processflow.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "group": { "type": "boolean" }, "title": { "type": "boolean" }, "details": { "type": "boolean" }, "order": { "type": "boolean" }, "reliesOnTrue": { "type": "boolean" }, "reliesOnFalse": { "type": "boolean" }, "inputType": { "type": "boolean" }, "checkboxEntries": { "type": "boolean" }, "fileUploadEntries": { "type": "boolean" }, "stateEntries": { "type": "boolean" }, "yesNoEntries": { "type": "boolean" }, "selectBoxEntries": { "type": "boolean" }, "entries": { "type": "boolean" }, "datePickerEntries": { "type": "boolean" }, "textareaEntries": { "type": "boolean" }, "optional": { "type": "boolean" }, "internalOnly": { "type": "boolean" }, "sendsEmailOnCompletion": { "type": "boolean" }, "causesRepContactOnCompletion": { "type": "boolean" }, "ruleGroupsAreOr": { "type": "boolean" }, "stage": { "type": "boolean" }, "internalComments": { "type": "boolean" }, "textfieldName": { "type": "boolean" }, "helpDoc": { "type": "boolean" }, "checkboxEnabler": { "type": "boolean" }, "textfieldEntries": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "group", "title", "details", "order", "reliesOnTrue", "reliesOnFalse", "inputType", "checkboxEntries", "fileUploadEntries", "stateEntries", "yesNoEntries", "selectBoxEntries", "entries", "datePickerEntries", "textareaEntries", "optional", "internalOnly", "sendsEmailOnCompletion", "causesRepContactOnCompletion", "ruleGroupsAreOr", "stage", "internalComments", "textfieldName", "helpDoc", "checkboxEnabler", "textfieldEntries" ], "example": "id" }, "uniqueItems": true } ], "title": "Processflow.Fields" }, "include": { "title": "Processflow.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Processflow.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Products.Filter": { "type": "object", "title": "Products.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "Products.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Products.Filter1": { "type": "object", "title": "Products.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Products.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "Products.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CommitProspectImport": { "type": "object", "required": [ "companyId", "mapping" ], "properties": { "companyId": { "type": "number" }, "fileName": { "type": "string" }, "contentBase64": { "type": "string" }, "parseToken": { "type": "string" }, "mapping": { "type": "object" } }, "title": "CommitProspectImport" }, "ParseProspectImport": { "type": "object", "required": [ "companyId", "fileName", "contentBase64" ], "properties": { "companyId": { "type": "number" }, "fileName": { "type": "string" }, "contentBase64": { "type": "string" } }, "title": "ParseProspectImport" }, "Prospect.Filter": { "type": "object", "title": "Prospect.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Prospect.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "firstName": { "type": "boolean" }, "lastName": { "type": "boolean" }, "email": { "type": "boolean" }, "phone": { "type": "boolean" }, "address": { "type": "boolean" }, "city": { "type": "boolean" }, "state": { "type": "boolean" }, "zip": { "type": "boolean" }, "w2Count": { "type": "boolean" }, "status": { "type": "boolean" }, "unsubscribedAt": { "type": "boolean" }, "bouncedAt": { "type": "boolean" }, "complainedAt": { "type": "boolean" }, "convertedCompanyId": { "type": "boolean" }, "attributedCampaignId": { "type": "boolean" }, "convertedAt": { "type": "boolean" }, "convertedBy": { "type": "boolean" }, "convertedBookingId": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "firstName", "lastName", "email", "phone", "address", "city", "state", "zip", "w2Count", "status", "unsubscribedAt", "bouncedAt", "complainedAt", "convertedCompanyId", "attributedCampaignId", "convertedAt", "convertedBy", "convertedBookingId", "createdAt", "updatedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "Prospect.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UpdateQuestionForJason": { "type": "object", "properties": { "question": { "type": "string" }, "tag": { "type": "string", "nullable": true }, "answered": { "type": "boolean" } }, "title": "UpdateQuestionForJason" }, "NewQuestionForJason": { "type": "object", "required": [ "question" ], "properties": { "question": { "type": "string" }, "tag": { "type": "string", "nullable": true } }, "title": "NewQuestionForJason" }, "QuestionForJason.Filter": { "type": "object", "title": "QuestionForJason.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "QuestionForJason.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "question": { "type": "boolean" }, "tag": { "type": "boolean" }, "answered": { "type": "boolean" }, "createdBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "question", "tag", "answered", "createdBy", "createdAt", "updatedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "QuestionForJason.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Referrer.Filter": { "type": "object", "title": "Referrer.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "commissionPercentage": { "type": "boolean" }, "referrerId": { "type": "boolean" }, "affiliateId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "commissionPercentage", "referrerId", "affiliateId" ], "example": "id" }, "uniqueItems": true } ], "title": "Referrer.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Referrer.Filter1": { "type": "object", "title": "Referrer.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Referrer.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "commissionPercentage": { "type": "boolean" }, "referrerId": { "type": "boolean" }, "affiliateId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "commissionPercentage", "referrerId", "affiliateId" ], "example": "id" }, "uniqueItems": true } ], "title": "Referrer.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RepairStageCategories.Filter": { "type": "object", "title": "RepairStageCategories.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "isAccountant": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "name": { "type": "boolean" }, "requiredRoleGroup": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "isAccountant", "isPublic", "name", "requiredRoleGroup" ], "example": "description" }, "uniqueItems": true } ], "title": "RepairStageCategories.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RepairStageCategories.Filter1": { "type": "object", "title": "RepairStageCategories.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "RepairStageCategories.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "isAccountant": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "name": { "type": "boolean" }, "requiredRoleGroup": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "isAccountant", "isPublic", "name", "requiredRoleGroup" ], "example": "description" }, "uniqueItems": true } ], "title": "RepairStageCategories.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RepairStageHistory.Filter": { "type": "object", "title": "RepairStageHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "changeBy": { "type": "boolean" }, "changeWhen": { "type": "boolean" }, "id": { "type": "boolean" }, "notes": { "type": "boolean" }, "processflow": { "type": "boolean" }, "stageFrom": { "type": "boolean" }, "stageTo": { "type": "boolean" }, "syncChange": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "changeBy", "changeWhen", "id", "notes", "processflow", "stageFrom", "stageTo", "syncChange" ], "example": "changeBy" }, "uniqueItems": true } ], "title": "RepairStageHistory.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RepairStageHistory.Filter1": { "type": "object", "title": "RepairStageHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "RepairStageHistory.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "changeBy": { "type": "boolean" }, "changeWhen": { "type": "boolean" }, "id": { "type": "boolean" }, "notes": { "type": "boolean" }, "processflow": { "type": "boolean" }, "stageFrom": { "type": "boolean" }, "stageTo": { "type": "boolean" }, "syncChange": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "changeBy", "changeWhen", "id", "notes", "processflow", "stageFrom", "stageTo", "syncChange" ], "example": "changeBy" }, "uniqueItems": true } ], "title": "RepairStageHistory.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RepairStages.Filter": { "type": "object", "title": "RepairStages.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "isAccountant": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "parent": { "type": "boolean" }, "requiredRoleGroup": { "type": "boolean" }, "title": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "isAccountant", "isPublic", "parent", "requiredRoleGroup", "title" ], "example": "description" }, "uniqueItems": true } ], "title": "RepairStages.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RepairStages.Filter1": { "type": "object", "title": "RepairStages.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "RepairStages.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "isAccountant": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "parent": { "type": "boolean" }, "requiredRoleGroup": { "type": "boolean" }, "title": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "isAccountant", "isPublic", "parent", "requiredRoleGroup", "title" ], "example": "description" }, "uniqueItems": true } ], "title": "RepairStages.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RewardActivityType.Filter": { "type": "object", "title": "RewardActivityType.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "RewardActivityType.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "slug": { "type": "boolean" }, "name": { "type": "boolean" }, "level": { "type": "boolean" }, "groupSlug": { "type": "boolean" }, "cptCode": { "type": "boolean" }, "valueCents": { "type": "boolean" }, "frequencyCap": { "type": "boolean" }, "frequencyPeriod": { "type": "boolean" }, "documentationRequired": { "type": "boolean" }, "active": { "type": "boolean" }, "effectiveFrom": { "type": "boolean" }, "effectiveTo": { "type": "boolean" }, "notes": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "slug", "name", "level", "groupSlug", "cptCode", "valueCents", "frequencyCap", "frequencyPeriod", "documentationRequired", "active", "effectiveFrom", "effectiveTo", "notes", "createdAt", "updatedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "RewardActivityType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RoleGroupEntries.Filter": { "type": "object", "title": "RoleGroupEntries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "roleId": { "type": "boolean" }, "roleGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "roleId", "roleGroupId" ], "example": "id" }, "uniqueItems": true } ], "title": "RoleGroupEntries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RoleGroupEntries.Filter1": { "type": "object", "title": "RoleGroupEntries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "RoleGroupEntries.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "roleId": { "type": "boolean" }, "roleGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "roleId", "roleGroupId" ], "example": "id" }, "uniqueItems": true } ], "title": "RoleGroupEntries.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RoleGroupUsers.Filter": { "type": "object", "title": "RoleGroupUsers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "roleGroupsId": { "type": "boolean" }, "clearErcUserId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "roleGroupsId", "clearErcUserId" ], "example": "id" }, "uniqueItems": true } ], "title": "RoleGroupUsers.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RoleGroupUsers.Filter1": { "type": "object", "title": "RoleGroupUsers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "RoleGroupUsers.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "roleGroupsId": { "type": "boolean" }, "clearErcUserId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "roleGroupsId", "clearErcUserId" ], "example": "id" }, "uniqueItems": true } ], "title": "RoleGroupUsers.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RoleGroups.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "RoleGroups.ScopeFilter" }, "RoleGroups.IncludeFilter.Items": { "title": "RoleGroups.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "roles", "processflowGroups" ] }, "scope": { "$ref": "#/components/schemas/RoleGroups.ScopeFilter" } } }, "RoleGroups.Filter": { "type": "object", "title": "RoleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "owner": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isForCompany": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description", "owner", "isPublic", "isForCompany" ], "example": "id" }, "uniqueItems": true } ], "title": "RoleGroups.Fields" }, "include": { "title": "RoleGroups.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RoleGroups.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RoleGroups.Filter1": { "type": "object", "title": "RoleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "RoleGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "owner": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isForCompany": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "description", "owner", "isPublic", "isForCompany" ], "example": "id" }, "uniqueItems": true } ], "title": "RoleGroups.Fields" }, "include": { "title": "RoleGroups.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RoleGroups.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RoleUsers.Filter": { "type": "object", "title": "RoleUsers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "roleId": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "roleId", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "RoleUsers.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RoleUsers.Filter1": { "type": "object", "title": "RoleUsers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "RoleUsers.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "roleId": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "roleId", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "RoleUsers.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Roles.Filter": { "type": "object", "title": "Roles.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "roleCode": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "roleCode" ], "example": "id" }, "uniqueItems": true } ], "title": "Roles.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Roles.Filter1": { "type": "object", "title": "Roles.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Roles.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "roleCode": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "roleCode" ], "example": "id" }, "uniqueItems": true } ], "title": "Roles.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "NewSalesMaterialFromDocument": { "type": "object", "required": [ "companyDocumentId" ], "properties": { "companyDocumentId": { "type": "number" }, "name": { "type": "string" }, "audience": { "type": "string", "enum": [ "partner", "employer", "both" ] } }, "title": "NewSalesMaterialFromDocument" }, "UpdateSalesMaterial": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "retired" ] }, "audience": { "type": "string", "enum": [ "partner", "employer", "both" ] }, "kind": { "type": "string", "enum": [ "document", "presentation" ] }, "personalization": { "type": "object", "nullable": true, "additionalProperties": true } }, "title": "UpdateSalesMaterial" }, "NewSignedContract": { "title": "NewSignedContract", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, schemaOptions: { title: 'NewSignedContract', optional: [ 'id', 'companyId', 'dateCreated', 'dateUpdated' ] })", "properties": { "id": { "type": "number" }, "contractType": { "type": "string", "nullable": false }, "companyName": { "type": "string", "nullable": true }, "companyId": { "type": "number", "nullable": true }, "companyState": { "type": "string", "nullable": true }, "companyAddress": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "perEntireMonthlyLifePerMonth": { "type": "string", "nullable": true }, "printName": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "effectiveDate": { "type": "string", "nullable": true }, "signatureText": { "type": "string", "nullable": true }, "signatureFont": { "type": "string", "nullable": true }, "signingIpAddress": { "type": "string", "nullable": true }, "signerEmail": { "type": "string", "nullable": true }, "pdfFieldValues": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "signedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "dateUpdated": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "renderedPdfFilename": { "type": "string", "nullable": true }, "voidedAt": { "type": "string", "format": "date-time", "nullable": true }, "voidedById": { "type": "string", "nullable": true }, "voidReason": { "type": "string", "nullable": true }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "deletedById": { "type": "string", "nullable": true }, "magicLinkCode": { "type": "string", "description": "Transient documentSign magic-link code. Used ONLY to resolve the signer identity server-side from the linked document_send; never persisted." } }, "required": [ "contractType" ], "additionalProperties": false }, "SignedContracts.Filter": { "type": "object", "title": "SignedContracts.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "SignedContracts.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "contractType": { "type": "boolean" }, "companyName": { "type": "boolean" }, "companyId": { "type": "boolean" }, "companyState": { "type": "boolean" }, "companyAddress": { "type": "boolean" }, "companyType": { "type": "boolean" }, "perEntireMonthlyLifePerMonth": { "type": "boolean" }, "printName": { "type": "boolean" }, "title": { "type": "boolean" }, "effectiveDate": { "type": "boolean" }, "signatureText": { "type": "boolean" }, "signatureFont": { "type": "boolean" }, "signingIpAddress": { "type": "boolean" }, "signerEmail": { "type": "boolean" }, "pdfFieldValues": { "type": "boolean" }, "dateCreated": { "type": "boolean" }, "signedAt": { "type": "boolean" }, "createdBy": { "type": "boolean" }, "dateUpdated": { "type": "boolean" }, "updatedBy": { "type": "boolean" }, "renderedPdfFilename": { "type": "boolean" }, "voidedAt": { "type": "boolean" }, "voidedById": { "type": "boolean" }, "voidReason": { "type": "boolean" }, "deletedAt": { "type": "boolean" }, "deletedById": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "contractType", "companyName", "companyId", "companyState", "companyAddress", "companyType", "perEntireMonthlyLifePerMonth", "printName", "title", "effectiveDate", "signatureText", "signatureFont", "signingIpAddress", "signerEmail", "pdfFieldValues", "dateCreated", "signedAt", "createdBy", "dateUpdated", "updatedBy", "renderedPdfFilename", "voidedAt", "voidedById", "voidReason", "deletedAt", "deletedById" ], "example": "id" }, "uniqueItems": true } ], "title": "SignedContracts.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "SmsMessage.Filter": { "type": "object", "title": "SmsMessage.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "SmsMessage.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "direction": { "type": "boolean" }, "fromNumber": { "type": "boolean" }, "toNumber": { "type": "boolean" }, "body": { "type": "boolean" }, "messageSid": { "type": "boolean" }, "numMedia": { "type": "boolean" }, "mediaJson": { "type": "boolean" }, "payloadJson": { "type": "boolean" }, "userId": { "type": "boolean" }, "companyId": { "type": "boolean" }, "status": { "type": "boolean" }, "staffAssistantThreadId": { "type": "boolean" }, "createdAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "direction", "fromNumber", "toNumber", "body", "messageSid", "numMedia", "mediaJson", "payloadJson", "userId", "companyId", "status", "staffAssistantThreadId", "createdAt" ], "example": "id" }, "uniqueItems": true } ], "title": "SmsMessage.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "GetIdResponse": { "type": "object", "title": "GetIdResponse", "properties": {} }, "StaffAssistantAskRequest": { "type": "object", "required": [ "question" ], "properties": { "question": { "type": "string" }, "threadId": { "type": "number" } }, "title": "StaffAssistantAskRequest" }, "StageHistory.Filter": { "type": "object", "title": "StageHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "processflow": { "type": "boolean" }, "stageFrom": { "type": "boolean" }, "stageTo": { "type": "boolean" }, "changeWhen": { "type": "boolean" }, "syncChange": { "type": "boolean" }, "changeBy": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "processflow", "stageFrom", "stageTo", "changeWhen", "syncChange", "changeBy", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "StageHistory.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "StageHistory.Filter1": { "type": "object", "title": "StageHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "StageHistory.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "processflow": { "type": "boolean" }, "stageFrom": { "type": "boolean" }, "stageTo": { "type": "boolean" }, "changeWhen": { "type": "boolean" }, "syncChange": { "type": "boolean" }, "changeBy": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "processflow", "stageFrom", "stageTo", "changeWhen", "syncChange", "changeBy", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "StageHistory.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Stages.Filter": { "type": "object", "title": "Stages.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "isAccountant": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "name": { "type": "boolean" }, "parent": { "type": "boolean" }, "productId": { "type": "boolean" }, "requiredRoleGroup": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "isAccountant", "isPublic", "name", "parent", "productId", "requiredRoleGroup" ], "example": "description" }, "uniqueItems": true } ], "title": "Stages.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Stages.Filter1": { "type": "object", "title": "Stages.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Stages.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "description": { "type": "boolean" }, "id": { "type": "boolean" }, "isAccountant": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "name": { "type": "boolean" }, "parent": { "type": "boolean" }, "productId": { "type": "boolean" }, "requiredRoleGroup": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "isAccountant", "isPublic", "name", "parent", "productId", "requiredRoleGroup" ], "example": "description" }, "uniqueItems": true } ], "title": "Stages.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "StepRuleGroups.Filter": { "type": "object", "title": "StepRuleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "businessRuleGroupId": { "type": "boolean" }, "id": { "type": "boolean" }, "processflowId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "businessRuleGroupId", "id", "processflowId" ], "example": "businessRuleGroupId" }, "uniqueItems": true } ], "title": "StepRuleGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "StepRuleGroups.Filter1": { "type": "object", "title": "StepRuleGroups.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "StepRuleGroups.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "businessRuleGroupId": { "type": "boolean" }, "id": { "type": "boolean" }, "processflowId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "businessRuleGroupId", "id", "processflowId" ], "example": "businessRuleGroupId" }, "uniqueItems": true } ], "title": "StepRuleGroups.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CannedResponsePatch": { "type": "object", "properties": { "title": { "type": "string" }, "category": { "type": "string", "nullable": true }, "bodyHtml": { "type": "string" }, "sortOrder": { "type": "number" } }, "title": "CannedResponsePatch" }, "NewCannedResponse": { "type": "object", "required": [ "title", "bodyHtml" ], "properties": { "title": { "type": "string" }, "category": { "type": "string", "nullable": true }, "bodyHtml": { "type": "string" }, "sortOrder": { "type": "number" } }, "title": "NewCannedResponse" }, "SupportEscalationSummaryRequest": { "type": "object", "properties": { "question": { "type": "string" }, "history": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string" }, "content": { "type": "string" } } } } }, "title": "SupportEscalationSummaryRequest" }, "NewSupportAttachment": { "type": "object", "required": [ "filename" ], "properties": { "filename": { "type": "string" }, "originalFilename": { "type": "string" }, "mimetype": { "type": "string" }, "encoding": { "type": "string" }, "size": { "type": "number" }, "messageId": { "type": "number" } }, "title": "NewSupportAttachment" }, "NewSupportMessage": { "type": "object", "properties": { "bodyHtml": { "type": "string" }, "internal": { "type": "boolean" }, "cannedResponseId": { "type": "number" } }, "title": "NewSupportMessage" }, "SupportTicketPatch": { "type": "object", "properties": { "status": { "type": "string" }, "category": { "type": "string" }, "priority": { "type": "string" }, "assigneeUserId": { "type": "string", "nullable": true }, "requesterUserId": { "type": "string", "nullable": true } }, "title": "SupportTicketPatch" }, "NewSupportTicket": { "type": "object", "required": [ "subject", "bodyHtml" ], "properties": { "subject": { "type": "string" }, "category": { "type": "string" }, "bodyHtml": { "type": "string" }, "aiTranscript": { "type": "array", "items": { "type": "object" } }, "attachments": { "type": "array", "items": { "type": "object", "required": [ "fileUploadId" ], "properties": { "fileUploadId": { "type": "number" } } } } }, "title": "NewSupportTicket" }, "TourStateSave": { "type": "object", "required": [ "status", "version" ], "properties": { "status": { "type": "string", "enum": [ "offered", "dismissed", "completed" ] }, "version": { "type": "integer", "minimum": 1 } }, "title": "TourStateSave" }, "TpaInvoices.Filter": { "type": "object", "title": "TpaInvoices.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "lives": { "type": "boolean" }, "pricePerLife": { "type": "boolean" }, "groupAdvisorsPayout": { "type": "boolean" }, "affiliateUserId": { "type": "boolean" }, "salesRepId": { "type": "boolean" }, "affiliateManagerId": { "type": "boolean" }, "affiliateAmount": { "type": "boolean" }, "salesRepAmount": { "type": "boolean" }, "affiliateManagerAmount": { "type": "boolean" }, "subAffiliateUserId": { "type": "boolean" }, "subAffiliateAmount": { "type": "boolean" }, "subSubAffiliateUserId": { "type": "boolean" }, "subSubAffiliateAmount": { "type": "boolean" }, "subSubSubAffiliateUserId": { "type": "boolean" }, "subSubSubAffiliateAmount": { "type": "boolean" }, "referrer1Id": { "type": "boolean" }, "referrer1Amount": { "type": "boolean" }, "referrer2Id": { "type": "boolean" }, "referrer2Amount": { "type": "boolean" }, "referrer3Id": { "type": "boolean" }, "referrer3Amount": { "type": "boolean" }, "referrer4Id": { "type": "boolean" }, "referrer4Amount": { "type": "boolean" }, "referrer5Id": { "type": "boolean" }, "referrer5Amount": { "type": "boolean" }, "referrer6Id": { "type": "boolean" }, "referrer6Amount": { "type": "boolean" }, "erFee": { "type": "boolean" }, "erLives": { "type": "boolean" }, "totalEmployeePrice": { "type": "boolean" }, "totalEmployerPrice": { "type": "boolean" }, "totalUSHealthPrice": { "type": "boolean" }, "totalInsurancePrice": { "type": "boolean" }, "totalGrossPayout": { "type": "boolean" }, "grossProfit": { "type": "boolean" }, "details": { "type": "boolean" }, "invoiceDatetime": { "type": "boolean" }, "payPeriod": { "type": "boolean" }, "achRejected": { "type": "boolean" }, "payDate": { "type": "boolean" }, "notes": { "type": "boolean" }, "employerPricePerLife": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "lives", "pricePerLife", "groupAdvisorsPayout", "affiliateUserId", "salesRepId", "affiliateManagerId", "affiliateAmount", "salesRepAmount", "affiliateManagerAmount", "subAffiliateUserId", "subAffiliateAmount", "subSubAffiliateUserId", "subSubAffiliateAmount", "subSubSubAffiliateUserId", "subSubSubAffiliateAmount", "referrer1Id", "referrer1Amount", "referrer2Id", "referrer2Amount", "referrer3Id", "referrer3Amount", "referrer4Id", "referrer4Amount", "referrer5Id", "referrer5Amount", "referrer6Id", "referrer6Amount", "erFee", "erLives", "totalEmployeePrice", "totalEmployerPrice", "totalUSHealthPrice", "totalInsurancePrice", "totalGrossPayout", "grossProfit", "details", "invoiceDatetime", "payPeriod", "achRejected", "payDate", "notes", "employerPricePerLife" ], "example": "id" }, "uniqueItems": true } ], "title": "TpaInvoices.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "TpaInvoices.Filter1": { "type": "object", "title": "TpaInvoices.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "TpaInvoices.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "lives": { "type": "boolean" }, "pricePerLife": { "type": "boolean" }, "groupAdvisorsPayout": { "type": "boolean" }, "affiliateUserId": { "type": "boolean" }, "salesRepId": { "type": "boolean" }, "affiliateManagerId": { "type": "boolean" }, "affiliateAmount": { "type": "boolean" }, "salesRepAmount": { "type": "boolean" }, "affiliateManagerAmount": { "type": "boolean" }, "subAffiliateUserId": { "type": "boolean" }, "subAffiliateAmount": { "type": "boolean" }, "subSubAffiliateUserId": { "type": "boolean" }, "subSubAffiliateAmount": { "type": "boolean" }, "subSubSubAffiliateUserId": { "type": "boolean" }, "subSubSubAffiliateAmount": { "type": "boolean" }, "referrer1Id": { "type": "boolean" }, "referrer1Amount": { "type": "boolean" }, "referrer2Id": { "type": "boolean" }, "referrer2Amount": { "type": "boolean" }, "referrer3Id": { "type": "boolean" }, "referrer3Amount": { "type": "boolean" }, "referrer4Id": { "type": "boolean" }, "referrer4Amount": { "type": "boolean" }, "referrer5Id": { "type": "boolean" }, "referrer5Amount": { "type": "boolean" }, "referrer6Id": { "type": "boolean" }, "referrer6Amount": { "type": "boolean" }, "erFee": { "type": "boolean" }, "erLives": { "type": "boolean" }, "totalEmployeePrice": { "type": "boolean" }, "totalEmployerPrice": { "type": "boolean" }, "totalUSHealthPrice": { "type": "boolean" }, "totalInsurancePrice": { "type": "boolean" }, "totalGrossPayout": { "type": "boolean" }, "grossProfit": { "type": "boolean" }, "details": { "type": "boolean" }, "invoiceDatetime": { "type": "boolean" }, "payPeriod": { "type": "boolean" }, "achRejected": { "type": "boolean" }, "payDate": { "type": "boolean" }, "notes": { "type": "boolean" }, "employerPricePerLife": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "lives", "pricePerLife", "groupAdvisorsPayout", "affiliateUserId", "salesRepId", "affiliateManagerId", "affiliateAmount", "salesRepAmount", "affiliateManagerAmount", "subAffiliateUserId", "subAffiliateAmount", "subSubAffiliateUserId", "subSubAffiliateAmount", "subSubSubAffiliateUserId", "subSubSubAffiliateAmount", "referrer1Id", "referrer1Amount", "referrer2Id", "referrer2Amount", "referrer3Id", "referrer3Amount", "referrer4Id", "referrer4Amount", "referrer5Id", "referrer5Amount", "referrer6Id", "referrer6Amount", "erFee", "erLives", "totalEmployeePrice", "totalEmployerPrice", "totalUSHealthPrice", "totalInsurancePrice", "totalGrossPayout", "grossProfit", "details", "invoiceDatetime", "payPeriod", "achRejected", "payDate", "notes", "employerPricePerLife" ], "example": "id" }, "uniqueItems": true } ], "title": "TpaInvoices.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "TransactionStatusHistory.Filter": { "type": "object", "title": "TransactionStatusHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "transactionId": { "type": "boolean" }, "preValue": { "type": "boolean" }, "postValue": { "type": "boolean" }, "changeDatetime": { "type": "boolean" }, "changedBy": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "transactionId", "preValue", "postValue", "changeDatetime", "changedBy" ], "example": "id" }, "uniqueItems": true } ], "title": "TransactionStatusHistory.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "TransactionStatusHistory.Filter1": { "type": "object", "title": "TransactionStatusHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "TransactionStatusHistory.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "transactionId": { "type": "boolean" }, "preValue": { "type": "boolean" }, "postValue": { "type": "boolean" }, "changeDatetime": { "type": "boolean" }, "changedBy": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "transactionId", "preValue", "postValue", "changeDatetime", "changedBy" ], "example": "id" }, "uniqueItems": true } ], "title": "TransactionStatusHistory.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "TransactionStatus.Filter": { "type": "object", "title": "TransactionStatus.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name" ], "example": "id" }, "uniqueItems": true } ], "title": "TransactionStatus.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "TransactionStatus.Filter1": { "type": "object", "title": "TransactionStatus.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "TransactionStatus.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name" ], "example": "id" }, "uniqueItems": true } ], "title": "TransactionStatus.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Transaction.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Transaction.ScopeFilter" }, "Transaction.IncludeFilter.Items": { "title": "Transaction.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "payment", "createdByUser", "company", "lineItem", "toCompany", "fromCompany", "toUser", "fromUser" ] }, "scope": { "$ref": "#/components/schemas/Transaction.ScopeFilter" } } }, "Transaction.Filter": { "type": "object", "title": "Transaction.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "deletedAt": { "type": "boolean" }, "invoiceDate": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "paymentId": { "type": "boolean" }, "createdById": { "type": "boolean" }, "companyId": { "type": "boolean" }, "lineItemId": { "type": "boolean" }, "toCompanyId": { "type": "boolean" }, "fromCompanyId": { "type": "boolean" }, "toUserId": { "type": "boolean" }, "companyType": { "type": "boolean" }, "to": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "fromUserId": { "type": "boolean" }, "from": { "type": "boolean" }, "type": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "toUs": { "type": "boolean" }, "fromUs": { "type": "boolean" }, "amount": { "type": "boolean" }, "amountPerLife": { "type": "boolean" }, "lives": { "type": "boolean" }, "lineItemID": { "type": "boolean" }, "tpaInvoiceId": { "type": "boolean" }, "affiliateId": { "type": "boolean" }, "statusId": { "type": "boolean" }, "discountPercentage": { "type": "boolean" }, "notes": { "type": "boolean" }, "status": { "type": "boolean" }, "description": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "deletedAt", "invoiceDate", "updatedAt", "paymentId", "createdById", "companyId", "lineItemId", "toCompanyId", "fromCompanyId", "toUserId", "companyType", "to", "deletedBy", "fromUserId", "from", "type", "isDeleted", "toUs", "fromUs", "amount", "amountPerLife", "lives", "lineItemID", "tpaInvoiceId", "affiliateId", "statusId", "discountPercentage", "notes", "status", "description" ], "example": "id" }, "uniqueItems": true } ], "title": "Transaction.Fields" }, "include": { "title": "Transaction.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Transaction.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Transaction.Filter1": { "type": "object", "title": "Transaction.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Transaction.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "deletedAt": { "type": "boolean" }, "invoiceDate": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "paymentId": { "type": "boolean" }, "createdById": { "type": "boolean" }, "companyId": { "type": "boolean" }, "lineItemId": { "type": "boolean" }, "toCompanyId": { "type": "boolean" }, "fromCompanyId": { "type": "boolean" }, "toUserId": { "type": "boolean" }, "companyType": { "type": "boolean" }, "to": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "fromUserId": { "type": "boolean" }, "from": { "type": "boolean" }, "type": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "toUs": { "type": "boolean" }, "fromUs": { "type": "boolean" }, "amount": { "type": "boolean" }, "amountPerLife": { "type": "boolean" }, "lives": { "type": "boolean" }, "lineItemID": { "type": "boolean" }, "tpaInvoiceId": { "type": "boolean" }, "affiliateId": { "type": "boolean" }, "statusId": { "type": "boolean" }, "discountPercentage": { "type": "boolean" }, "notes": { "type": "boolean" }, "status": { "type": "boolean" }, "description": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "deletedAt", "invoiceDate", "updatedAt", "paymentId", "createdById", "companyId", "lineItemId", "toCompanyId", "fromCompanyId", "toUserId", "companyType", "to", "deletedBy", "fromUserId", "from", "type", "isDeleted", "toUs", "fromUs", "amount", "amountPerLife", "lives", "lineItemID", "tpaInvoiceId", "affiliateId", "statusId", "discountPercentage", "notes", "status", "description" ], "example": "id" }, "uniqueItems": true } ], "title": "Transaction.Fields" }, "include": { "title": "Transaction.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Transaction.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "TransactionNew.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "TransactionNew.ScopeFilter" }, "TransactionNew.IncludeFilter.Items": { "title": "TransactionNew.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "sourceCompany", "destinationCompany", "clientCompany" ] }, "scope": { "$ref": "#/components/schemas/TransactionNew.ScopeFilter" } } }, "TransactionNew.Filter": { "type": "object", "title": "TransactionNew.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "TransactionNew.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "createdById": { "type": "boolean" }, "sourceCompanyId": { "type": "boolean" }, "destinationCompanyId": { "type": "boolean" }, "sourceUserId": { "type": "boolean" }, "destinationUserId": { "type": "boolean" }, "clientCompanyId": { "type": "boolean" }, "role": { "type": "boolean" }, "kind": { "type": "boolean" }, "amount": { "type": "boolean" }, "lives": { "type": "boolean" }, "amountPerLife": { "type": "boolean" }, "billingPeriodStart": { "type": "boolean" }, "billingPeriodEnd": { "type": "boolean" }, "occurredAt": { "type": "boolean" }, "tpaInvoiceId": { "type": "boolean" }, "state": { "type": "boolean" }, "description": { "type": "boolean" }, "notes": { "type": "boolean" }, "legacySource": { "type": "boolean" }, "legacyId": { "type": "boolean" }, "importBatchId": { "type": "boolean" }, "sourceSnapshot": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "createdAt", "updatedAt", "createdById", "sourceCompanyId", "destinationCompanyId", "sourceUserId", "destinationUserId", "clientCompanyId", "role", "kind", "amount", "lives", "amountPerLife", "billingPeriodStart", "billingPeriodEnd", "occurredAt", "tpaInvoiceId", "state", "description", "notes", "legacySource", "legacyId", "importBatchId", "sourceSnapshot" ], "example": "id" }, "uniqueItems": true } ], "title": "TransactionNew.Fields" }, "include": { "title": "TransactionNew.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/TransactionNew.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UserCompany.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "UserCompany.ScopeFilter" }, "UserCompany.IncludeFilter.Items": { "title": "UserCompany.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "ercUser", "company", "roleGroup" ] }, "scope": { "$ref": "#/components/schemas/UserCompany.ScopeFilter" } } }, "UserCompany.Filter": { "type": "object", "title": "UserCompany.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "commissionPercentage": { "type": "boolean" }, "id": { "type": "boolean" }, "totalFeePercent": { "type": "boolean" }, "totalFeeAmount": { "type": "boolean" }, "totalFeeType": { "type": "boolean" }, "upfrontFeePercent": { "type": "boolean" }, "upfrontFeeAmount": { "type": "boolean" }, "upfrontFeeType": { "type": "boolean" }, "upfrontFeeDate": { "type": "boolean" }, "depositFeePercent": { "type": "boolean" }, "depositFeeAmount": { "type": "boolean" }, "depositFeeType": { "type": "boolean" }, "depositFeeDate": { "type": "boolean" }, "laterFeePercent": { "type": "boolean" }, "laterFeeAmount": { "type": "boolean" }, "laterFeeType": { "type": "boolean" }, "laterFeeDate": { "type": "boolean" }, "inviteDispatchedAt": { "type": "boolean" }, "ercUserId": { "type": "boolean" }, "companyId": { "type": "boolean" }, "roleGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "commissionPercentage", "id", "totalFeePercent", "totalFeeAmount", "totalFeeType", "upfrontFeePercent", "upfrontFeeAmount", "upfrontFeeType", "upfrontFeeDate", "depositFeePercent", "depositFeeAmount", "depositFeeType", "depositFeeDate", "laterFeePercent", "laterFeeAmount", "laterFeeType", "laterFeeDate", "inviteDispatchedAt", "ercUserId", "companyId", "roleGroupId" ], "example": "commissionPercentage" }, "uniqueItems": true } ], "title": "UserCompany.Fields" }, "include": { "title": "UserCompany.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/UserCompany.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UserCompany.Filter1": { "type": "object", "title": "UserCompany.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "UserCompany.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "commissionPercentage": { "type": "boolean" }, "id": { "type": "boolean" }, "totalFeePercent": { "type": "boolean" }, "totalFeeAmount": { "type": "boolean" }, "totalFeeType": { "type": "boolean" }, "upfrontFeePercent": { "type": "boolean" }, "upfrontFeeAmount": { "type": "boolean" }, "upfrontFeeType": { "type": "boolean" }, "upfrontFeeDate": { "type": "boolean" }, "depositFeePercent": { "type": "boolean" }, "depositFeeAmount": { "type": "boolean" }, "depositFeeType": { "type": "boolean" }, "depositFeeDate": { "type": "boolean" }, "laterFeePercent": { "type": "boolean" }, "laterFeeAmount": { "type": "boolean" }, "laterFeeType": { "type": "boolean" }, "laterFeeDate": { "type": "boolean" }, "inviteDispatchedAt": { "type": "boolean" }, "ercUserId": { "type": "boolean" }, "companyId": { "type": "boolean" }, "roleGroupId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "commissionPercentage", "id", "totalFeePercent", "totalFeeAmount", "totalFeeType", "upfrontFeePercent", "upfrontFeeAmount", "upfrontFeeType", "upfrontFeeDate", "depositFeePercent", "depositFeeAmount", "depositFeeType", "depositFeeDate", "laterFeePercent", "laterFeeAmount", "laterFeeType", "laterFeeDate", "inviteDispatchedAt", "ercUserId", "companyId", "roleGroupId" ], "example": "commissionPercentage" }, "uniqueItems": true } ], "title": "UserCompany.Fields" }, "include": { "title": "UserCompany.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/UserCompany.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UserLevel.Filter": { "type": "object", "title": "UserLevel.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "slug": { "type": "boolean" }, "name": { "type": "boolean" }, "roleGroupId": { "type": "boolean" }, "companyType": { "type": "boolean" }, "resolveVia": { "type": "boolean" }, "sortOrder": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "slug", "name", "roleGroupId", "companyType", "resolveVia", "sortOrder" ], "example": "id" }, "uniqueItems": true } ], "title": "UserLevel.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UserLevel.Filter1": { "type": "object", "title": "UserLevel.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "UserLevel.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "slug": { "type": "boolean" }, "name": { "type": "boolean" }, "roleGroupId": { "type": "boolean" }, "companyType": { "type": "boolean" }, "resolveVia": { "type": "boolean" }, "sortOrder": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "slug", "name", "roleGroupId", "companyType", "resolveVia", "sortOrder" ], "example": "id" }, "uniqueItems": true } ], "title": "UserLevel.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UserSettings.Filter": { "type": "object", "title": "UserSettings.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "settingName": { "type": "boolean" }, "settingValue": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "settingName", "settingValue" ], "example": "id" }, "uniqueItems": true } ], "title": "UserSettings.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UserSettings.Filter1": { "type": "object", "title": "UserSettings.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "UserSettings.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "settingName": { "type": "boolean" }, "settingValue": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "settingName", "settingValue" ], "example": "id" }, "uniqueItems": true } ], "title": "UserSettings.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Response": { "type": "object", "title": "Response", "properties": { "success": { "type": "boolean" } } }, "UtmLinks.Filter": { "type": "object", "title": "UtmLinks.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "lastUpdated": { "type": "boolean" }, "lastEntityAdded": { "type": "boolean" }, "code": { "type": "boolean" }, "name": { "type": "boolean" }, "source": { "type": "boolean" }, "medium": { "type": "boolean" }, "campaign": { "type": "boolean" }, "term": { "type": "boolean" }, "content": { "type": "boolean" }, "notes": { "type": "boolean" }, "owner": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "lastUpdated", "lastEntityAdded", "code", "name", "source", "medium", "campaign", "term", "content", "notes", "owner" ], "example": "id" }, "uniqueItems": true } ], "title": "UtmLinks.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UtmLinks.Filter1": { "type": "object", "title": "UtmLinks.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "UtmLinks.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "lastUpdated": { "type": "boolean" }, "lastEntityAdded": { "type": "boolean" }, "code": { "type": "boolean" }, "name": { "type": "boolean" }, "source": { "type": "boolean" }, "medium": { "type": "boolean" }, "campaign": { "type": "boolean" }, "term": { "type": "boolean" }, "content": { "type": "boolean" }, "notes": { "type": "boolean" }, "owner": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "lastUpdated", "lastEntityAdded", "code", "name", "source", "medium", "campaign", "term", "content", "notes", "owner" ], "example": "id" }, "uniqueItems": true } ], "title": "UtmLinks.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UtmLog.Filter": { "type": "object", "title": "UtmLog.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "eventDatetime": { "type": "boolean" }, "utm": { "type": "boolean" }, "site": { "type": "boolean" }, "userId": { "type": "boolean" }, "ipAddress": { "type": "boolean" }, "notes": { "type": "boolean" }, "data": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "eventDatetime", "utm", "site", "userId", "ipAddress", "notes", "data" ], "example": "id" }, "uniqueItems": true } ], "title": "UtmLog.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UtmLog.Filter1": { "type": "object", "title": "UtmLog.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "UtmLog.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "eventDatetime": { "type": "boolean" }, "utm": { "type": "boolean" }, "site": { "type": "boolean" }, "userId": { "type": "boolean" }, "ipAddress": { "type": "boolean" }, "notes": { "type": "boolean" }, "data": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "eventDatetime", "utm", "site", "userId", "ipAddress", "notes", "data" ], "example": "id" }, "uniqueItems": true } ], "title": "UtmLog.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "VideoConceptMessageRequest": { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string" } }, "title": "VideoConceptMessageRequest" }, "SceneRenderRequest": { "type": "object", "properties": { "tier": { "type": "string" }, "resolution": { "type": "string" }, "mediaType": { "type": "string" }, "promptNote": { "type": "string" }, "referenceFileUploadIds": { "type": "array", "items": { "type": "number" } } }, "title": "SceneRenderRequest" }, "SceneSettingsRequest": { "type": "object", "properties": { "tier": { "type": "string", "nullable": true }, "resolution": { "type": "string", "nullable": true }, "mediaType": { "type": "string", "nullable": true }, "motion": { "type": "string", "nullable": true } }, "title": "SceneSettingsRequest" }, "VideoScriptReviseRequest": { "type": "object", "required": [ "instruction" ], "properties": { "instruction": { "type": "string" } }, "title": "VideoScriptReviseRequest" }, "VideoScriptSceneAmendmentResponse": { "type": "object", "properties": { "amendment": { "type": "object", "properties": { "id": { "type": "number" }, "videoId": { "type": "number" }, "scriptId": { "type": "number" }, "sceneIndex": { "type": "number" }, "visualPrompt": { "type": "string", "nullable": true }, "durationSeconds": { "type": "number", "nullable": true }, "createdByUser": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true } } }, "effectiveStoryboard": { "type": "array", "items": { "type": "object" } } }, "title": "VideoScriptSceneAmendmentResponse" }, "VideoScriptSceneAmendmentRequest": { "type": "object", "properties": { "visualPrompt": { "type": "string" }, "durationSeconds": { "type": "number" } }, "title": "VideoScriptSceneAmendmentRequest" }, "VideoScriptHandEditRequest": { "type": "object", "required": [ "storyboard", "transcript" ], "properties": { "storyboard": { "type": "array", "items": { "type": "object" } }, "transcript": { "type": "string" } }, "title": "VideoScriptHandEditRequest" }, "ComposeTakeRequest": { "type": "object", "properties": { "overrides": { "type": "array", "items": { "type": "object", "properties": { "sceneIndex": { "type": "number" }, "renderJobId": { "type": "number" } } } } }, "title": "ComposeTakeRequest" }, "PatchVideoRequest": { "type": "object", "properties": { "title": { "type": "string" }, "sourceMaterial": { "type": "string" }, "style": { "type": "string" }, "quality": { "type": "string" }, "resolution": { "type": "string" }, "aspectRatio": { "type": "string" }, "targetDurationSeconds": { "type": "number" }, "takeCount": { "type": "number" }, "voiceId": { "type": "string", "nullable": true }, "musicTrackKey": { "type": "string", "nullable": true }, "burnInLogo": { "type": "boolean" }, "introStyle": { "type": "string" }, "endCard": { "type": "boolean" }, "liveForCompanyTypes": { "type": "array", "items": { "type": "string" } } }, "title": "PatchVideoRequest" }, "CreateVideoRequest": { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string" }, "style": { "type": "string" }, "quality": { "type": "string" }, "resolution": { "type": "string" }, "aspectRatio": { "type": "string" }, "targetDurationSeconds": { "type": "number" }, "takeCount": { "type": "number" }, "sourceMaterial": { "type": "string" } }, "title": "CreateVideoRequest" }, "WellnessCensus.Filter": { "type": "object", "title": "WellnessCensus.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "f_2020W4Box2cTwoJobs": { "type": "boolean" }, "f_2020W4FederalDependentsAmount": { "type": "boolean" }, "f_401kContributionTotalPp": { "type": "boolean" }, "additionalPreTaxDeductionsTotalPp": { "type": "boolean" }, "businessPhone": { "type": "boolean" }, "carrier": { "type": "boolean" }, "city": { "type": "boolean" }, "companyDepartment": { "type": "boolean" }, "companyDepartmentCode": { "type": "boolean" }, "dob": { "type": "boolean" }, "effectiveDate": { "type": "boolean" }, "email": { "type": "boolean" }, "employeeContributionMajorMedicalTotalPp": { "type": "boolean" }, "employeeUsername": { "type": "boolean" }, "employerLocationDivision": { "type": "boolean" }, "exemptFromSs": { "type": "boolean" }, "exemptionAmountClaimed": { "type": "boolean" }, "externalId": { "type": "boolean" }, "federal_2020W4Used": { "type": "boolean" }, "federalExemptionsClaimed": { "type": "boolean" }, "federalMaritalFilingStatus": { "type": "boolean" }, "firstName": { "type": "boolean" }, "gender": { "type": "boolean" }, "grossWagesPerPayPeriod": { "type": "boolean" }, "groupName": { "type": "boolean" }, "hireDate": { "type": "boolean" }, "homePhone": { "type": "boolean" }, "id": { "type": "boolean" }, "lastName": { "type": "boolean" }, "medicalTier": { "type": "boolean" }, "paySchedule": { "type": "boolean" }, "postTaxDeductionsTotalPp": { "type": "boolean" }, "prAllowancesBasedOnDeductions": { "type": "boolean" }, "prNonResident": { "type": "boolean" }, "prVeteranExemption": { "type": "boolean" }, "prYoungAdult": { "type": "boolean" }, "relationshipStatus": { "type": "boolean" }, "spouseWorks": { "type": "boolean" }, "ssn": { "type": "boolean" }, "stateDependentExemptionsClaimed": { "type": "boolean" }, "stateEmployeeFilesIn": { "type": "boolean" }, "stateExemptionsClaimed": { "type": "boolean" }, "stateMaritalFilingStatus": { "type": "boolean" }, "stateOfResidence": { "type": "boolean" }, "streetAddress": { "type": "boolean" }, "streetAddress_2": { "type": "boolean" }, "subscriberId": { "type": "boolean" }, "witholdingRate": { "type": "boolean" }, "companyId": { "type": "boolean" }, "dateAdded": { "type": "boolean" }, "zip": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "f_2020W4Box2cTwoJobs", "f_2020W4FederalDependentsAmount", "f_401kContributionTotalPp", "additionalPreTaxDeductionsTotalPp", "businessPhone", "carrier", "city", "companyDepartment", "companyDepartmentCode", "dob", "effectiveDate", "email", "employeeContributionMajorMedicalTotalPp", "employeeUsername", "employerLocationDivision", "exemptFromSs", "exemptionAmountClaimed", "externalId", "federal_2020W4Used", "federalExemptionsClaimed", "federalMaritalFilingStatus", "firstName", "gender", "grossWagesPerPayPeriod", "groupName", "hireDate", "homePhone", "id", "lastName", "medicalTier", "paySchedule", "postTaxDeductionsTotalPp", "prAllowancesBasedOnDeductions", "prNonResident", "prVeteranExemption", "prYoungAdult", "relationshipStatus", "spouseWorks", "ssn", "stateDependentExemptionsClaimed", "stateEmployeeFilesIn", "stateExemptionsClaimed", "stateMaritalFilingStatus", "stateOfResidence", "streetAddress", "streetAddress_2", "subscriberId", "witholdingRate", "companyId", "dateAdded", "zip" ], "example": "f_2020W4Box2cTwoJobs" }, "uniqueItems": true } ], "title": "WellnessCensus.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "WellnessCensus.Filter1": { "type": "object", "title": "WellnessCensus.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "WellnessCensus.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "f_2020W4Box2cTwoJobs": { "type": "boolean" }, "f_2020W4FederalDependentsAmount": { "type": "boolean" }, "f_401kContributionTotalPp": { "type": "boolean" }, "additionalPreTaxDeductionsTotalPp": { "type": "boolean" }, "businessPhone": { "type": "boolean" }, "carrier": { "type": "boolean" }, "city": { "type": "boolean" }, "companyDepartment": { "type": "boolean" }, "companyDepartmentCode": { "type": "boolean" }, "dob": { "type": "boolean" }, "effectiveDate": { "type": "boolean" }, "email": { "type": "boolean" }, "employeeContributionMajorMedicalTotalPp": { "type": "boolean" }, "employeeUsername": { "type": "boolean" }, "employerLocationDivision": { "type": "boolean" }, "exemptFromSs": { "type": "boolean" }, "exemptionAmountClaimed": { "type": "boolean" }, "externalId": { "type": "boolean" }, "federal_2020W4Used": { "type": "boolean" }, "federalExemptionsClaimed": { "type": "boolean" }, "federalMaritalFilingStatus": { "type": "boolean" }, "firstName": { "type": "boolean" }, "gender": { "type": "boolean" }, "grossWagesPerPayPeriod": { "type": "boolean" }, "groupName": { "type": "boolean" }, "hireDate": { "type": "boolean" }, "homePhone": { "type": "boolean" }, "id": { "type": "boolean" }, "lastName": { "type": "boolean" }, "medicalTier": { "type": "boolean" }, "paySchedule": { "type": "boolean" }, "postTaxDeductionsTotalPp": { "type": "boolean" }, "prAllowancesBasedOnDeductions": { "type": "boolean" }, "prNonResident": { "type": "boolean" }, "prVeteranExemption": { "type": "boolean" }, "prYoungAdult": { "type": "boolean" }, "relationshipStatus": { "type": "boolean" }, "spouseWorks": { "type": "boolean" }, "ssn": { "type": "boolean" }, "stateDependentExemptionsClaimed": { "type": "boolean" }, "stateEmployeeFilesIn": { "type": "boolean" }, "stateExemptionsClaimed": { "type": "boolean" }, "stateMaritalFilingStatus": { "type": "boolean" }, "stateOfResidence": { "type": "boolean" }, "streetAddress": { "type": "boolean" }, "streetAddress_2": { "type": "boolean" }, "subscriberId": { "type": "boolean" }, "witholdingRate": { "type": "boolean" }, "companyId": { "type": "boolean" }, "dateAdded": { "type": "boolean" }, "zip": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "f_2020W4Box2cTwoJobs", "f_2020W4FederalDependentsAmount", "f_401kContributionTotalPp", "additionalPreTaxDeductionsTotalPp", "businessPhone", "carrier", "city", "companyDepartment", "companyDepartmentCode", "dob", "effectiveDate", "email", "employeeContributionMajorMedicalTotalPp", "employeeUsername", "employerLocationDivision", "exemptFromSs", "exemptionAmountClaimed", "externalId", "federal_2020W4Used", "federalExemptionsClaimed", "federalMaritalFilingStatus", "firstName", "gender", "grossWagesPerPayPeriod", "groupName", "hireDate", "homePhone", "id", "lastName", "medicalTier", "paySchedule", "postTaxDeductionsTotalPp", "prAllowancesBasedOnDeductions", "prNonResident", "prVeteranExemption", "prYoungAdult", "relationshipStatus", "spouseWorks", "ssn", "stateDependentExemptionsClaimed", "stateEmployeeFilesIn", "stateExemptionsClaimed", "stateMaritalFilingStatus", "stateOfResidence", "streetAddress", "streetAddress_2", "subscriberId", "witholdingRate", "companyId", "dateAdded", "zip" ], "example": "f_2020W4Box2cTwoJobs" }, "uniqueItems": true } ], "title": "WellnessCensus.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "WellnessQuote.Filter": { "type": "object", "title": "WellnessQuote.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "firstName": { "type": "boolean" }, "lastName": { "type": "boolean" }, "state": { "type": "boolean" }, "filingStatus": { "type": "boolean" }, "exemptionsClaimed": { "type": "boolean" }, "paySchedule": { "type": "boolean" }, "grossWagesPerPayPeriod": { "type": "boolean" }, "employeeSavingsPerPayPeriod": { "type": "boolean" }, "employeeSavingsMonthly": { "type": "boolean" }, "annualEmployerSavings": { "type": "boolean" }, "wellnessEmployeeId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "firstName", "lastName", "state", "filingStatus", "exemptionsClaimed", "paySchedule", "grossWagesPerPayPeriod", "employeeSavingsPerPayPeriod", "employeeSavingsMonthly", "annualEmployerSavings", "wellnessEmployeeId" ], "example": "id" }, "uniqueItems": true } ], "title": "WellnessQuote.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "WellnessQuote.Filter1": { "type": "object", "title": "WellnessQuote.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "WellnessQuote.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "firstName": { "type": "boolean" }, "lastName": { "type": "boolean" }, "state": { "type": "boolean" }, "filingStatus": { "type": "boolean" }, "exemptionsClaimed": { "type": "boolean" }, "paySchedule": { "type": "boolean" }, "grossWagesPerPayPeriod": { "type": "boolean" }, "employeeSavingsPerPayPeriod": { "type": "boolean" }, "employeeSavingsMonthly": { "type": "boolean" }, "annualEmployerSavings": { "type": "boolean" }, "wellnessEmployeeId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "firstName", "lastName", "state", "filingStatus", "exemptionsClaimed", "paySchedule", "grossWagesPerPayPeriod", "employeeSavingsPerPayPeriod", "employeeSavingsMonthly", "annualEmployerSavings", "wellnessEmployeeId" ], "example": "id" }, "uniqueItems": true } ], "title": "WellnessQuote.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "WellnessShortCensus.Filter": { "type": "object", "title": "WellnessShortCensus.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "lastName": { "type": "boolean" }, "firstName": { "type": "boolean" }, "stateEmployeeFilesIn": { "type": "boolean" }, "paySchedule": { "type": "boolean" }, "grossWagesPerPayPeriod": { "type": "boolean" }, "employeeContributionMajorMedicalTotalPp": { "type": "boolean" }, "federal2020W4Used": { "type": "boolean" }, "federalMaritalFilingStatus": { "type": "boolean" }, "federalExemptionsClaimed": { "type": "boolean" }, "stateMaritalFilingStatus": { "type": "boolean" }, "hireDate": { "type": "boolean" }, "stateExemptionsClaimed": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "lastName", "firstName", "stateEmployeeFilesIn", "paySchedule", "grossWagesPerPayPeriod", "employeeContributionMajorMedicalTotalPp", "federal2020W4Used", "federalMaritalFilingStatus", "federalExemptionsClaimed", "stateMaritalFilingStatus", "hireDate", "stateExemptionsClaimed" ], "example": "id" }, "uniqueItems": true } ], "title": "WellnessShortCensus.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "WellnessShortCensus.Filter1": { "type": "object", "title": "WellnessShortCensus.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "WellnessShortCensus.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "companyId": { "type": "boolean" }, "lastName": { "type": "boolean" }, "firstName": { "type": "boolean" }, "stateEmployeeFilesIn": { "type": "boolean" }, "paySchedule": { "type": "boolean" }, "grossWagesPerPayPeriod": { "type": "boolean" }, "employeeContributionMajorMedicalTotalPp": { "type": "boolean" }, "federal2020W4Used": { "type": "boolean" }, "federalMaritalFilingStatus": { "type": "boolean" }, "federalExemptionsClaimed": { "type": "boolean" }, "stateMaritalFilingStatus": { "type": "boolean" }, "hireDate": { "type": "boolean" }, "stateExemptionsClaimed": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "companyId", "lastName", "firstName", "stateEmployeeFilesIn", "paySchedule", "grossWagesPerPayPeriod", "employeeContributionMajorMedicalTotalPp", "federal2020W4Used", "federalMaritalFilingStatus", "federalExemptionsClaimed", "stateMaritalFilingStatus", "hireDate", "stateExemptionsClaimed" ], "example": "id" }, "uniqueItems": true } ], "title": "WellnessShortCensus.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ZipCodes.Filter": { "type": "object", "title": "ZipCodes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "city": { "type": "boolean" }, "county": { "type": "boolean" }, "id": { "type": "boolean" }, "lat": { "type": "boolean" }, "long": { "type": "boolean" }, "state": { "type": "boolean" }, "zipCode": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "city", "county", "id", "lat", "long", "state", "zipCode" ], "example": "city" }, "uniqueItems": true } ], "title": "ZipCodes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ZipCodes.Filter1": { "type": "object", "title": "ZipCodes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ZipCodes.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "city": { "type": "boolean" }, "county": { "type": "boolean" }, "id": { "type": "boolean" }, "lat": { "type": "boolean" }, "long": { "type": "boolean" }, "state": { "type": "boolean" }, "zipCode": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "city", "county", "id", "lat", "long", "state", "zipCode" ], "example": "city" }, "uniqueItems": true } ], "title": "ZipCodes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "jwt": [] } ] }